taverna-reference-api/src/main/java/org/apache/taverna/reference/StreamToValueConverterSPI.java

/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.
*/

package org.apache.taverna.reference;

import java.io.InputStream;

/**
 * SPI for objects that can render a POJO from an InputStream
 * 
 * @author Tom Oinn
 */
public interface StreamToValueConverterSPI<T> {
	/**
	 * The class of objects which this builder can construct from a stream
	 */
	Class<T> getPojoClass();

	/**
	 * Render the stream to the target object type
	 * 
	 * @param stream
	 *            input stream of data to render to the object; the caller will
	 *            close it
	 * @param charset
	 * @param dataNature
	 * @return the newly created object
	 */
	T renderFrom(InputStream stream, ReferencedDataNature dataNature,
			String charset);
}