env/src/main/java/com/att/inno/env/old/IOStringifier.java

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