env/src/main/java/com/att/inno/env/Objectifier.java

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