de.drv.dsrv.extra.marshaller.IExtraUnmarschaller Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of extra-schema Show documentation
eXTra Schema for XSD
The newest version!
/*
 * 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 de.drv.dsrv.extra.marshaller;

import java.io.IOException;
import java.io.InputStream;

import javax.xml.transform.Source;

import org.springframework.oxm.XmlMappingException;

/**
 * @author Leonid Potap
 * @version $Id: IExtraUnmarschaller.java 1417 2012-12-28 11:07:10Z
 *          [email protected] $
 */
public interface IExtraUnmarschaller {

	/**
	 * Aus dem InputStream wird ein ExtraTransport Class ermittelt und
	 * unmarschalled. Es findet keine Validierung statt
	 * 
	 * @param inputStream
	 * @param extraTransportClass
	 *            das erwartete extraRootElement.Class
	 * @return the instance of extraTransportClass
	 * @throws XmlMappingException
	 * @throws IOException
	 */
	public  X unmarshal(InputStream inputStream, Class extraTransportClass)
			throws XmlMappingException, IOException;

	/**
	 * From an InputStream create an object corresponding to the specified
	 * extraTransportClass. Checks if the input stream contains the specified
	 * Object
	 * 
	 * @param inputStream
	 * @param extraTransportClass
	 *            das erwartete extraRootElement.Class
	 * @param validation
	 *            , wenn validation true, inputStream wird beim marschallen
	 *            validiert
	 * @return the instance of extraTransportClass
	 * @throws XmlMappingException
	 * @throws IOException
	 */
	public  X unmarshal(InputStream inputStream,
			Class extraTransportClass, boolean validation)
			throws XmlMappingException, IOException;

	/**
	 * Aus dem StreamSource wird ein ExtraTransport Class ermittelt und
	 * unmarschalled. Es findet keine Validierung statt
	 * 
	 * @param streamSource
	 * @param extraTransportClass
	 *            das erwartete extraRootElement.Class
	 * @return the instance of extraTransportClass
	 * @throws XmlMappingException
	 * @throws IOException
	 */
	public  X unmarshal(final Source source,
			final Class extraTransportClass, final boolean validation)
			throws XmlMappingException, IOException;

	/**
	 * Aus dem StreamSource wird ein ExtraTransport Class ermittelt und
	 * unmarschalled. Es findet keine Validierung statt
	 * 
	 * @param streamSource
	 * @param extraTransportClass
	 *            das erwartete extraRootElement.Class
	 * @return the instance of extraTransportClass
	 * @throws XmlMappingException
	 * @throws IOException
	 */
	public  X unmarshal(final Source source,
			final Class extraTransportClass) throws XmlMappingException,
			IOException;
}