utils/yangutils/src/main/java/org/onosproject/yangutils/parser/Parsable.java

/*
 * Copyright 2016-present 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.parser;

import org.onosproject.yangutils.datamodel.exceptions.DataModelException;
import org.onosproject.yangutils.utils.YangConstructType;

/**
 * Abstraction of an entity which process the data of lexer's parse tree.
 */
public interface Parsable {

    /**
     * Returns the type of YANG construct data.
     *
     * @return the type of YANG construct data.
     */
    YangConstructType getYangConstructType();

    /**
     * Checks if the node is valid as per YANG grammar's syntax and semantics.
     * This validation will be performed on entering the node in traversal
     *
     * @throws DataModelException if there is any violation of the YANG rules
     * in parsed data, corresponding exception should be thrown
     */
    void validateDataOnEntry() throws DataModelException;

    /**
     * Checks if the node is valid as per YANG grammar's syntax and semantics.
     * This validation will be performed on exiting the node in traversal
     *
     * @throws DataModelException if there is any violation of the YANG rules
     * in parsed data, corresponding exception should be thrown
     */
    void validateDataOnExit() throws DataModelException;
}