1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
/*
* ============LICENSE_START=======================================================
* ONAP PAP
* ================================================================================
* Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* ============LICENSE_END=========================================================
*/
package org.onap.policy.common.utils.coder;
import java.io.File;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.Reader;
import java.io.Writer;
/**
* JSON encoder and decoder.
*/
public interface Coder {
/**
* Encodes an object into json.
*
* @param object object to be encoded
* @return a json string representing the object
* @throws CoderException if an error occurs
*/
String encode(Object object) throws CoderException;
/**
* Encodes an object into json, writing to the given target.
*
* @param target target to which to write the encoded json
* @param object object to be encoded
* @throws CoderException if an error occurs
*/
void encode(Writer target, Object object) throws CoderException;
/**
* Encodes an object into json, writing to the given target.
*
* @param target target to which to write the encoded json
* @param object object to be encoded
* @throws CoderException if an error occurs
*/
void encode(OutputStream target, Object object) throws CoderException;
/**
* Encodes an object into json, writing to the given target.
*
* @param target target to which to write the encoded json
* @param object object to be encoded
* @throws CoderException if an error occurs
*/
void encode(File target, Object object) throws CoderException;
/**
* Decodes json into an object.
*
* @param json json string to be decoded
* @param clazz class of object to be decoded
* @return the object represented by the given json string
* @throws CoderException if an error occurs
*/
<T> T decode(String json, Class<T> clazz) throws CoderException;
/**
* Decodes json into an object, reading it from the given source.
*
* @param source source from which to read the json string to be decoded
* @param clazz class of object to be decoded
* @return the object represented by the given json string
* @throws CoderException if an error occurs
*/
<T> T decode(Reader source, Class<T> clazz) throws CoderException;
/**
* Decodes json into an object, reading it from the given source.
*
* @param source source from which to read the json string to be decoded
* @param clazz class of object to be decoded
* @return the object represented by the given json string
* @throws CoderException if an error occurs
*/
<T> T decode(InputStream source, Class<T> clazz) throws CoderException;
/**
* Decodes json into an object, reading it from the given source.
*
* @param source source from which to read the json string to be decoded
* @param clazz class of object to be decoded
* @return the object represented by the given json string
* @throws CoderException if an error occurs
*/
<T> T decode(File source, Class<T> clazz) throws CoderException;
/**
* Converts an object/POJO to a standard object.
*
* @param object object to be converted
* @return a new standard object representing the original object
* @throws CoderException if an error occurs
*/
StandardCoderObject toStandard(Object object) throws CoderException;
/**
* Converts a standard object to an object/POJO.
*
* @param sco the standard object to be converted
* @return a new object represented by the standard object
* @throws CoderException if an error occurs
*/
<T> T fromStandard(StandardCoderObject sco, Class<T> clazz) throws CoderException;
}
|
