restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/dfserializer/JsonListener.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 com.fasterxml.jackson.databind.JsonNode;
  24 import org.onap.ccsdk.sli.core.sli.SvcLogicException;
  25 import org.onap.ccsdk.sli.plugins.yangserializers.pnserializer.NodeType;
  26
  27 /**
  28  * Abstraction of an entity which provides call back methods, which in turn
  29  * are called by JSON walker while walking the JSON tree. This interface
  30  * needs to be implemented by protocol, implementing listener based call
  31  * while doing JSON walk.
  32  */
  33 public interface JsonListener extends Listener {
  34
  35     /**
  36      * Call back invoked during JSON node entry. All other related
  37      * information can be obtained from the JSON node.
  38      *
  39      * @param nodeName JSON node name
  40      * @param node     JSON node
  41      * @param nodeType JSON node type
  42      * @throws SvcLogicException when node type is of wrong format
  43      */
  44     void enterJsonNode(String nodeName, JsonNode node, NodeType nodeType)
  45             throws SvcLogicException;
  46
  47     /**
  48      * Call back invoked during JSON node exit. All the related information
  49      * can be obtained from the JSON node.
  50      *
  51      * @param node JSON node
  52      * @throws SvcLogicException when JSON node exit doesn't happen
  53      */
  54     void exitJsonNode(JsonNode node) throws SvcLogicException;
  55 }