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