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