misc/env/src/main/java/org/onap/aaf/misc/env/old/Objectifier.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 /**
  23  *
  24  */
  25 package org.onap.aaf.misc.env.old;
  26
  27 import org.onap.aaf.misc.env.APIException;
  28 import org.onap.aaf.misc.env.Env;
  29 import org.onap.aaf.misc.env.LifeCycle;
  30
  31
  32 /**
  33  * <h1>Objectifier</h1>
  34  * <i>Objectifier</i> abstracts the unmarshaling of an Object from a String, and
  35  * the creation of an uninitialized object.
  36  */
  37 public interface Objectifier<T> extends LifeCycle {
  38         /**
  39          * Marshal to Object T from a String, using contents from Env as necessary.<p>
  40          *
  41          * Implementations should use the {@link Env} to call "env.startXMLTime()" to mark
  42          * XML time, since this is often a costly process.
  43          *
  44          * @param env
  45          * @param input
  46          * @return T
  47          * @throws APIException
  48          */
  49         public abstract T objectify(Env env, String input) throws APIException;
  50
  51         /**
  52          * Create a new object of type T.  This is often more efficiently done with
  53          * the underlying XML (or other) Library.
  54          * @return T
  55          * @throws APIException
  56          */
  57         public abstract T newInstance() throws APIException;
  58
  59
  60 }