misc/env/src/main/java/org/onap/aaf/misc/env/old/IOObjectifier.java

   1 /**\r
   2  * ============LICENSE_START====================================================\r
   3  * org.onap.aaf\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
  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  */\r
  21 \r
  22 package org.onap.aaf.misc.env.old;\r
  23 \r
  24 import java.io.InputStream;\r
  25 import java.io.Reader;\r
  26 \r
  27 import org.onap.aaf.misc.env.APIException;\r
  28 import org.onap.aaf.misc.env.Env;\r
  29 \r
  30 public interface IOObjectifier<T> extends Objectifier<T> {\r
  31     /**\r
  32      * Marshal to Object T from a Reader, using contents from Env as necessary.<p>\r
  33      * \r
  34      * Implementations should use the {@link Env} to call "env.startXMLTime()" to mark\r
  35      * XML time, since this is often a costly process.\r
  36      *\r
  37      * @param env\r
  38      * @param input\r
  39      * @return T\r
  40      * @throws APIException\r
  41      */\r
  42     public abstract T objectify(Env env, Reader rdr) throws APIException;\r
  43     \r
  44     /**\r
  45      * Marshal to Object T from an InputStream, using contents from Env as necessary.<p>\r
  46      * \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
  49      *\r
  50      * @param env\r
  51      * @param input\r
  52      * @return T\r
  53      * @throws APIException\r
  54      */\r
  55     public abstract T objectify(Env env, InputStream is) throws APIException;\r
  56 \r
  57 }\r