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

   1 /*******************************************************************************\r
   2  * ============LICENSE_START====================================================\r
   3  * * org.onap.aai\r
   4  * * ===========================================================================\r
   5  * * Copyright © 2017 AT&T Intellectual Property. All rights reserved.\r
   6  * * Copyright © 2017 Amdocs\r
   7  * * ===========================================================================\r
   8  * * Licensed under the Apache License, Version 2.0 (the "License");\r
   9  * * you may not use this file except in compliance with the License.\r
  10  * * You may obtain a copy of the License at\r
  11  * * \r
  12  *  *      http://www.apache.org/licenses/LICENSE-2.0\r
  13  * * \r
  14  *  * Unless required by applicable law or agreed to in writing, software\r
  15  * * distributed under the License is distributed on an "AS IS" BASIS,\r
  16  * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  17  * * See the License for the specific language governing permissions and\r
  18  * * limitations under the License.\r
  19  * * ============LICENSE_END====================================================\r
  20  * *\r
  21  * * ECOMP is a trademark and service mark of AT&T Intellectual Property.\r
  22  * *\r
  23  ******************************************************************************/\r
  24 package com.att.inno.env;\r
  25 \r
  26 import java.io.OutputStream;\r
  27 import java.io.Writer;\r
  28 \r
  29 /**\r
  30  * Allow Extended IO interface usage without muddying up the Stringifier Interface\r
  31  */\r
  32 public interface IOStringifier<T> extends Stringifier<T> {\r
  33         /**\r
  34          * Marshal from an Object T onto a Writer, using contents from Env as necessary.<p>\r
  35          * \r
  36          * Implementations should use the {@link Env} to call "env.startTime(<string>, Env.XML)" to mark\r
  37          * XML time, since this is often a costly process.\r
  38          *\r
  39          * @param env\r
  40          * @param input\r
  41          * @return String\r
  42          * @throws APIException\r
  43          */\r
  44         public abstract void stringify(Env env, T input, Writer writer, boolean ... options) throws APIException;\r
  45         \r
  46         /**\r
  47          * Marshal from a String to an Object T, using contents from Env as necessary.<p>\r
  48          * \r
  49          * Implementations should use the {@link Env} to call "env.startXMLTime()" to mark\r
  50          * XML time, since this is often a costly process.\r
  51          *\r
  52          * @param env\r
  53          * @param input\r
  54          * @return String\r
  55          * @throws APIException\r
  56          */\r
  57         public abstract void stringify(Env env, T input, OutputStream os, boolean ... options) throws APIException;\r
  58 \r
  59         /**\r
  60          * Set Pretty XML, where possible\r
  61          * \r
  62          * @param pretty\r
  63          * @throws APIException\r
  64          */\r
  65         public abstract IOStringifier<T> pretty(boolean pretty);\r
  66 \r
  67         /**\r
  68          * Set Generate Fragment\r
  69          * \r
  70          * @param fragment\r
  71          * @throws APIException\r
  72          */\r
  73         public abstract IOStringifier<T> asFragment(boolean fragment);\r
  74 \r
  75 \r
  76 }\r