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