apps/yms/api/src/main/java/org/onosproject/yms/ydt/YdtListener.java

/*
 * Copyright 2016-present Open Networking Foundation
 *
 * 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.yms.ydt;

/**
 * Abstraction of an entity which provide call back methods which are called
 * by YDT walker while walking the YANG data tree.
 * <p>
 * In a response to execute operation YMS returns the YMS operation results
 * with root YDT node. Now, protocols needs to walk through the YDT node and
 * constructs the corresponding data format string. Protocol can opt to use
 * listener or visitor based walking mechanism.
 * <p>
 * This interface needs to be implemented by protocol implementing listener's
 * based call backs while YDT walk.
 */
public interface YdtListener {

    /**
     * YANG data tree node's entry, it will be called during a node entry.
     * All the related information about the node can be obtain from the YDT
     * context.
     *
     * @param ydtContext YANG data tree context
     */
    void enterYdtNode(YdtContext ydtContext);

    /**
     * YANG data tree node's exit, it will be called during a node exit.
     * All the related information about the node can be obtain from the YDT
     * context.
     *
     * @param ydtContext YANG data tree context
     */
    void exitYdtNode(YdtContext ydtContext);
}