restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/DataFormatSerializer.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;
  22
  23 import java.util.List;
  24 import java.util.Map;
  25
  26 /**
  27  * Abstraction of serializer to encode/decode context memory parameters
  28  * to/from specified data format.
  29  */
  30 public abstract class DataFormatSerializer {
  31
  32     private DataFormat dataFormat;
  33     private DataFormatSerializerContext serializerContext;
  34
  35     /**
  36      * Creates an instance of data format serializer.
  37      *
  38      * @param dataFormat type of data format
  39      * @param serializerContext data format serializer context
  40      */
  41     protected DataFormatSerializer(DataFormat dataFormat,
  42         DataFormatSerializerContext serializerContext) {
  43         this.dataFormat = dataFormat;
  44         this.serializerContext = serializerContext;
  45     }
  46
  47     /**
  48      * Encodes context memory parameters to data format.
  49      *
  50      * @param param context memory parameter
  51      * @param annotations annotations
  52      * @return data format body
  53      */
  54     public abstract String encode(Map<String, String> param,
  55         Map<String, List<Annotation>> annotations);
  56
  57     /**
  58      * Decodes data format body to context memory parameters.
  59      *
  60      * @param dataFormatBody abstract node
  61      * @return context memory parameters
  62      */
  63     public abstract Map<String, String> decode(String dataFormatBody);
  64
  65     /**
  66      * Returns data format serializer context.
  67      *
  68      * @return data format serializer context
  69      */
  70     public DataFormatSerializerContext serializerContext() {
  71         return serializerContext;
  72     }
  73
  74     /**
  75      * Returns supported data format.
  76      *
  77      * @return supported data format
  78      */
  79     public DataFormat dataFormat() {
  80         return dataFormat;
  81     }
  82 }