restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/dfserializer/XmlListener.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP - CCSDK
   4  * ================================================================================
   5  * Copyright (C) 2018 Huawei Technologies Co., Ltd. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.ccsdk.sli.plugins.yangserializers.dfserializer;
  22
  23 import org.dom4j.Element;
  24
  25 /**
  26  * Abstraction of an entity which provides call back methods, which in turn
  27  * are called by XML walker while walking the XML tree. This interface needs
  28  * to be implemented by protocol implementing listener based call while doing
  29  * XML walk.
  30  */
  31 public interface XmlListener extends Listener {
  32
  33     /**
  34      * Callback invoked during a node entry. All the related information
  35      * about the node can be obtained from the element.
  36      *
  37      * @param element  current XML element
  38      * @param nodeType node type of the element
  39      */
  40     void enterXmlElement(Element element, XmlNodeType nodeType);
  41
  42     /**
  43      * Callback invoked during a node exit. All the related information about
  44      * the node can be obtained from the element.
  45      *
  46      * @param element current xml element.
  47      */
  48     void exitXmlElement(Element element);
  49 }