env/src/main/java/com/att/inno/env/Stringifier.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 package com.att.inno.env;\r
  25 \r
  26 \r
  27 \r
  28 /**\r
  29  * <h1>Stringifier</h1>\r
  30  * <i>Stringifier</i> abstracts the marshaling of a String to an Object\r
  31  */\r
  32 public interface Stringifier<T> extends LifeCycle {\r
  33         \r
  34         /**\r
  35          * Marshal from a String to an Object T, using contents from Env as necessary.<p>\r
  36          * \r
  37          * Implementations should use the {@link Env} to call "env.startXMLTime()" to mark\r
  38          * XML time, since this is often a costly process.\r
  39          *\r
  40          * @param env\r
  41          * @param input\r
  42          * @return String\r
  43          * @throws APIException\r
  44          */\r
  45         public abstract String stringify(Env env, T input, boolean ... options) throws APIException;\r
  46         \r
  47 }\r