2 * ============LICENSE_START====================================================
\r
4 * ===========================================================================
\r
5 * Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
\r
6 * ===========================================================================
\r
7 * Licensed under the Apache License, Version 2.0 (the "License");
\r
8 * you may not use this file except in compliance with the License.
\r
9 * You may obtain a copy of the License at
\r
11 * http://www.apache.org/licenses/LICENSE-2.0
\r
13 * Unless required by applicable law or agreed to in writing, software
\r
14 * distributed under the License is distributed on an "AS IS" BASIS,
\r
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
\r
16 * See the License for the specific language governing permissions and
\r
17 * limitations under the License.
\r
18 * ============LICENSE_END====================================================
\r
22 package org.onap.aaf.misc.env;
\r
24 import java.io.OutputStream;
\r
25 import java.io.Writer;
\r
28 * Allow Extended IO interface usage without muddying up the Stringifier Interface
\r
30 public interface IOStringifier<T> extends Stringifier<T> {
\r
32 * Marshal from an Object T onto a Writer, using contents from Env as necessary.<p>
\r
34 * Implementations should use the {@link Env} to call "env.startTime(<string>, Env.XML)" to mark
\r
35 * XML time, since this is often a costly process.
\r
40 * @throws APIException
\r
42 public abstract void stringify(Env env, T input, Writer writer, boolean ... options) throws APIException;
\r
45 * Marshal from a String to an Object T, using contents from Env as necessary.<p>
\r
47 * Implementations should use the {@link Env} to call "env.startXMLTime()" to mark
\r
48 * XML time, since this is often a costly process.
\r
53 * @throws APIException
\r
55 public abstract void stringify(Env env, T input, OutputStream os, boolean ... options) throws APIException;
\r
58 * Set Pretty XML, where possible
\r
61 * @throws APIException
\r
63 public abstract IOStringifier<T> pretty(boolean pretty);
\r
66 * Set Generate Fragment
\r
69 * @throws APIException
\r
71 public abstract IOStringifier<T> asFragment(boolean fragment);
\r