utils/yangutils/src/main/java/org/onosproject/yangutils/datamodel/YangType.java

/*
 * Copyright 2016 Open Networking Laboratory
 *
 * Licensed 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.onosproject.yangutils.datamodel;

import org.onosproject.yangutils.datamodel.exceptions.DataModelException;
import org.onosproject.yangutils.parser.Parsable;
import org.onosproject.yangutils.parser.ParsableDataType;

/*
 * Reference:RFC 6020.
 * The "type" statement takes as an argument a string that is the name
 *  of a YANG built-in type or a derived type, followed by an optional
 *  block of sub-statements that are used to put further restrictions
 *  on the type.
 *
 *  The restrictions that can be applied depend on the type being restricted.
 *  The type's sub-statements
 *
 * +------------------+---------+-------------+------------------------------------+
 * | substatement     | section | cardinality | mapped data type                   |
 * +------------------+---------+-------------+------------------------------------+
 * | bit              | 9.7.4   | 0..n        | - YangBit used in YangBits         |
 * | enum             | 9.6.4   | 0..n        | - YangEnum used in YangEnumeration |
 * | length           | 9.4.4   | 0..1        | - used for string                  |
 * | path             | 9.9.2   | 0..1        | - TODO leaf-ref                    |
 * | pattern          | 9.4.6   | 0..n        | - used for string                  |
 * | range            | 9.2.4   | 0..1        | - used for integer data type       |
 * | require-instance | 9.13.2  | 0..1        | - TODO instance-identifier         |
 * | type             | 7.4     | 0..n        | - TODO union                       |
 * +------------------+---------+-------------+------------------------------------+
 */

/**
 * Maintains the data type information.
 *
 * @param <T> YANG data type info.
 */
public class YangType<T> implements Parsable {

    /**
     * YANG data type name.
     */
    private String dataTypeName;

    /**
     * YANG data type.
     */
    private YangDataTypes dataType;

    private T dataTypeInfo;

    /**
     * Default constructor.
     */
    public YangType() {
    }

    /**
     * Get the name of data type.
     *
     * @return the name of data type.
     */
    public String getDataTypeName() {
        return dataTypeName;
    }

    /**
     * Set the name of the data type.
     *
     * @param typeName the name to set
     */
    public void setDataTypeName(String typeName) {
        dataTypeName = typeName;
    }

    /**
     * Get the type of data.
     *
     * @return the data type.
     */
    public YangDataTypes getDataType() {
        return dataType;
    }

    /**
     * Set the type of data.
     *
     * @param dataType data type.
     */
    public void setDataType(YangDataTypes dataType) {
        this.dataType = dataType;
    }

    /**
     * Get the data type meta data.
     *
     * @return the data type meta data.
     */
    public T getDataTypeInfo() {
        return dataTypeInfo;
    }

    /**
     * Set the data type meta data.
     *
     * @param dataTypeInfo the meta data to set
     */
    public void setDataTypeInfo(T dataTypeInfo) {
        this.dataTypeInfo = dataTypeInfo;
    }

    /**
     * Returns the type of the parsed data.
     *
     * @return returns TYPE_DATA.
     */
    public ParsableDataType getParsableDataType() {
        return ParsableDataType.TYPE_DATA;
    }

    /**
     * Validate the data on entering the corresponding parse tree node.
     *
     * @throws DataModelException a violation of data model rules.
     */
    public void validateDataOnEntry() throws DataModelException {
        // TODO auto-generated method stub, to be implemented by parser

    }

    /**
     * Validate the data on exiting the corresponding parse tree node.
     *
     * @throws DataModelException a violation of data model rules.
     */
    public void validateDataOnExit() throws DataModelException {
        // TODO auto-generated method stub, to be implemented by parser

    }
}