misc/env/src/main/java/org/onap/aaf/misc/env/IOStringifier.java

   1 /**
   2  * ============LICENSE_START====================================================
   3  * org.onap.aaf
   4  * ===========================================================================
   5  * Copyright (c) 2018 AT&T Intellectual Property. 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
  22 package org.onap.aaf.misc.env;
  23
  24 import java.io.OutputStream;
  25 import java.io.Writer;
  26
  27 /**
  28  * Allow Extended IO interface usage without muddying up the Stringifier Interface
  29  */
  30 public interface IOStringifier<T> extends Stringifier<T> {
  31         /**
  32          * Marshal from an Object T onto a Writer, using contents from Env as necessary.<p>
  33          *
  34          * Implementations should use the {@link Env} to call "env.startTime(<string>, Env.XML)" to mark
  35          * XML time, since this is often a costly process.
  36          *
  37          * @param env
  38          * @param input
  39          * @return String
  40          * @throws APIException
  41          */
  42         public abstract void stringify(Env env, T input, Writer writer, boolean ... options) throws APIException;
  43
  44         /**
  45          * Marshal from a String to an Object T, using contents from Env as necessary.<p>
  46          *
  47          * Implementations should use the {@link Env} to call "env.startXMLTime()" to mark
  48          * XML time, since this is often a costly process.
  49          *
  50          * @param env
  51          * @param input
  52          * @return String
  53          * @throws APIException
  54          */
  55         public abstract void stringify(Env env, T input, OutputStream os, boolean ... options) throws APIException;
  56
  57         /**
  58          * Set Pretty XML, where possible
  59          *
  60          * @param pretty
  61          * @throws APIException
  62          */
  63         public abstract IOStringifier<T> pretty(boolean pretty);
  64
  65         /**
  66          * Set Generate Fragment
  67          *
  68          * @param fragment
  69          * @throws APIException
  70          */
  71         public abstract IOStringifier<T> asFragment(boolean fragment);
  72
  73
  74 }