org.apache.cxf.databinding.DataReader Maven / Gradle / Ivy
/**
* 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.cxf.databinding;
import javax.xml.namespace.QName;
import org.apache.cxf.service.model.MessagePartInfo;
/**
* The 'read' side of the data binding abstraction of CXF. A DataReader<T> reads objects
* from a source of type T.
* @param The type of the source. Each data binding defines the set of source types that it supports.
*/
public interface DataReader extends BaseDataReader {
/**
* Read an object from the input.
* @param input input source object.
* @return item read.
*/
Object read(T input);
/**
* Read an object from the input, applying additional conventions based on the WSDL message
* part.
* @param part The message part for this item. If null, this API is equivalent to
* {@link #read(Object)}.
* @param input input source object.
* @return item read.
*/
Object read(MessagePartInfo part, T input);
/**
* Read an object from the input. In the current version of CXF, not all binding support
* this API, and those that do ignore the element QName parameter.
* @param elementQName expected element. Generally ignored.
* @param input input source object.
* @param type the type of object required/requested. This is generally used
* when the caller wants to receive a raw source object and avoid any binding processing.
* For example, passing javax.xml.transform.Source. The bindings do not necessarily throw
* if they cannot provide an object of the requested type, and will apply their normal
* mapping processing, instead.
* @return item read.
*/
Object read(QName elementQName, T input, Class type);
}