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
|
/*******************************************************************************
* ============LICENSE_START====================================================
* * org.onap.aaf
* * ===========================================================================
* * Copyright © 2017 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====================================================
* *
* * ECOMP is a trademark and service mark of AT&T Intellectual Property.
* *
******************************************************************************/
package org.onap.aaf.inno.env;
import java.io.OutputStream;
import java.io.Writer;
/**
* Allow Extended IO interface usage without muddying up the Stringifier Interface
*/
public interface IOStringifier<T> extends Stringifier<T> {
/**
* Marshal from an Object T onto a Writer, using contents from Env as necessary.<p>
*
* Implementations should use the {@link Env} to call "env.startTime(<string>, Env.XML)" to mark
* XML time, since this is often a costly process.
*
* @param env
* @param input
* @return String
* @throws APIException
*/
public abstract void stringify(Env env, T input, Writer writer, boolean ... options) throws APIException;
/**
* Marshal from a String to an Object T, using contents from Env as necessary.<p>
*
* Implementations should use the {@link Env} to call "env.startXMLTime()" to mark
* XML time, since this is often a costly process.
*
* @param env
* @param input
* @return String
* @throws APIException
*/
public abstract void stringify(Env env, T input, OutputStream os, boolean ... options) throws APIException;
/**
* Set Pretty XML, where possible
*
* @param pretty
* @throws APIException
*/
public abstract IOStringifier<T> pretty(boolean pretty);
/**
* Set Generate Fragment
*
* @param fragment
* @throws APIException
*/
public abstract IOStringifier<T> asFragment(boolean fragment);
}
|
