summaryrefslogtreecommitdiffstats
path: root/env/src/main/java/org/onap/aaf/inno/env/old/Objectifier.java
blob: 15536adef5a8da15d216b4bdd23661a0799ba326 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
/*******************************************************************************
 * ============LICENSE_START====================================================
 * * org.onap.aaf
 * * ===========================================================================
 * * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
 * * ===========================================================================
 * * Licensed under the Apache License, Version 2.0 (the "License");
 * * you may not use this file except in compliance with the License.
 * * You may obtain a copy of the License at
 * * 
 *  *      http://www.apache.org/licenses/LICENSE-2.0
 * * 
 *  * Unless required by applicable law or agreed to in writing, software
 * * distributed under the License is distributed on an "AS IS" BASIS,
 * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * * See the License for the specific language governing permissions and
 * * limitations under the License.
 * * ============LICENSE_END====================================================
 * *
 * * ECOMP is a trademark and service mark of AT&T Intellectual Property.
 * *
 ******************************************************************************/
/**
 * 
 */
package org.onap.aaf.inno.env.old;

import org.onap.aaf.inno.env.APIException;
import org.onap.aaf.inno.env.Env;
import org.onap.aaf.inno.env.LifeCycle;


/**
 * <h1>Objectifier</h1>
 * <i>Objectifier</i> abstracts the unmarshaling of an Object from a String, and 
 * the creation of an uninitialized object. 
 */
public interface Objectifier<T> extends LifeCycle {
	/**
	 * Marshal to Object T from a String, using contents from Env as necessary.<p>
	 * 
	 * Implementations should use the {@link Env} to call "env.startXMLTime()" to mark
	 * XML time, since this is often a costly process.
	 *
	 * @param env
	 * @param input
	 * @return T
	 * @throws APIException
	 */
	public abstract T objectify(Env env, String input) throws APIException;

	/**
	 * Create a new object of type T.  This is often more efficiently done with
	 * the underlying XML (or other) Library.
	 * @return T
	 * @throws APIException
	 */
	public abstract T newInstance() throws APIException;

	
}