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