2 * ============LICENSE_START=======================================================
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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=========================================================
21 package org.onap.ccsdk.sli.plugins.yangserializers.dfserializer;
23 import org.onap.ccsdk.sli.core.sli.SvcLogicException;
25 import java.util.List;
29 * Abstraction of serializer to encode/decode context memory parameters
30 * to/from specified data format.
32 public abstract class DataFormatSerializer {
35 * Data format type of the serializer.
37 private DataFormat dataFormat;
40 * Data format serializer context.
42 private DataFormatSerializerContext serializerContext;
45 * Creates an instance of data format serializer.
47 * @param d type of data format
48 * @param s data format serializer context
50 protected DataFormatSerializer(DataFormat d,
51 DataFormatSerializerContext s) {
53 this.serializerContext = s;
57 * Encodes context memory parameters to data format.
59 * @param param context memory parameter
60 * @param annotations annotations
61 * @return data format body
62 * @throws SvcLogicException when serialization fails
64 public abstract String encode(Map<String, String> param,
65 Map<String, List<Annotation>> annotations) throws SvcLogicException;
68 * Decodes data format body to context memory parameters.
70 * @param dataFormatBody abstract node
71 * @return context memory parameters
72 * @throws SvcLogicException when serialization fails
74 public abstract Map<String, String> decode(String dataFormatBody)
75 throws SvcLogicException;
78 * Returns data format serializer context.
80 * @return data format serializer context
82 public DataFormatSerializerContext serializerContext() {
83 return serializerContext;
87 * Returns supported data format.
89 * @return supported data format
91 public DataFormat dataFormat() {