misc/env/src/main/java/org/onap/aaf/misc/env/old/Stringifier.java

   1 /**
   2  * ============LICENSE_START====================================================
   3  * org.onap.aaf
   4  * ===========================================================================
   5  * Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
   6  * ===========================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END====================================================
  19  *
  20  */
  21
  22 package org.onap.aaf.misc.env.old;
  23
  24 import org.onap.aaf.misc.env.APIException;
  25 import org.onap.aaf.misc.env.Env;
  26 import org.onap.aaf.misc.env.LifeCycle;
  27
  28
  29 /**
  30  * <h1>Stringifier</h1>
  31  * <i>Stringifier</i> abstracts the marshaling of a String to an Object
  32  */
  33 public interface Stringifier<T> extends LifeCycle {
  34
  35         /**
  36          * Marshal from a String to an Object T, using contents from Env as necessary.<p>
  37          *
  38          * Implementations should use the {@link Env} to call "env.startXMLTime()" to mark
  39          * XML time, since this is often a costly process.
  40          *
  41          * @param env
  42          * @param input
  43          * @return String
  44          * @throws APIException
  45          */
  46         public abstract String stringify(Env env, T input, boolean ... options) throws APIException;
  47
  48 }