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