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 import org.onap.ccsdk.sli.core.sli.SvcLogicException;
  25
  26 /**
  27  * Abstraction of an entity which provides call back methods, which in turn
  28  * are called by XML walker while walking the XML tree. This interface needs
  29  * to be implemented by protocol implementing listener based call while doing
  30  * XML walk.
  31  */
  32 public interface XmlListener extends Listener {
  33
  34     /**
  35      * Callback invoked during a node entry. All the related information
  36      * about the node can be obtained from the element.
  37      *
  38      * @param element  current XML element
  39      * @param nodeType node type of the element
  40      * @throws SvcLogicException when node type is of wrong format
  41      */
  42     void enterXmlElement(Element element, XmlNodeType nodeType)
  43             throws SvcLogicException;
  44
  45     /**
  46      * Callback invoked during a node exit. All the related information about
  47      * the node can be obtained from the element.
  48      *
  49      * @param element current xml element.
  50      * @throws SvcLogicException when XML node exit doesn't happen
  51      */
  52     void exitXmlElement(Element element) throws SvcLogicException;
  53 }