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