IDataType.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.atlas.typesystem.types;

import org.apache.atlas.AtlasException;

import java.security.MessageDigest;
import java.util.Set;

public interface IDataType<T> {
    String getName();

    T convert(Object val, Multiplicity m) throws AtlasException;

    DataTypes.TypeCategory getTypeCategory();

    /**
     * Output a string representation of a value instance of this type.
     *
     * @param val
     * @param buf
     * @param prefix
     * @param inProcess
     * @throws AtlasException
     */
    void output(T val, Appendable buf, String prefix, Set<T> inProcess) throws AtlasException;

    /**
     * Output a string representation of this type.
     *
     * @param buf
     * @param typesInProcess
     * @throws AtlasException
     */
    void output(Appendable buf, Set<String> typesInProcess) throws AtlasException;

    void validateUpdate(IDataType newType) throws TypeUpdateException;

    void updateSignatureHash(MessageDigest digester, Object val) throws AtlasException;

    String getDescription();

    String getVersion();
}