restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/dfserializer/XmlWalker.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 interface for XML walk. This
  27  * interface serves as a common tool for anyone who needs to parse the XML
  28  * node with depth-first algorithm.
  29  */
  30 public interface XmlWalker {
  31
  32     /**
  33      * Walks the XML data tree. Protocols implement XML listener service and
  34      * walks the XML tree with input as implemented object. XML walker
  35      * provides call back to the implemented methods.
  36      *
  37      * @param listener   XML listener implemented by the protocol
  38      * @param xmlElement root element of the XML data tree
  39      */
  40     void walk(XmlListener listener, Element xmlElement);
  41 }