Author: dkulp
Date: Wed Jan 2 14:48:49 2008
New Revision: 608273
URL: http://svn.apache.org/viewvc?rev=608273&view=rev
Log:
Merged revisions 607622 via svnmerge from
https://svn.apache.org/repos/asf/incubator/cxf/trunk
........
r607622 | bimargulies | 2007-12-30 18:56:34 -0500 (Sun, 30 Dec 2007) | 2 lines
Add javadoc.
........
Modified:
incubator/cxf/branches/2.0.x-fixes/ (props changed)
incubator/cxf/branches/2.0.x-fixes/api/src/main/java/org/apache/cxf/databinding/DataReader.java
Propchange: incubator/cxf/branches/2.0.x-fixes/
------------------------------------------------------------------------------
Binary property 'svnmerge-integrated' - no diff available.
Modified:
incubator/cxf/branches/2.0.x-fixes/api/src/main/java/org/apache/cxf/databinding/DataReader.java
URL:
http://svn.apache.org/viewvc/incubator/cxf/branches/2.0.x-fixes/api/src/main/java/org/apache/cxf/databinding/DataReader.java?rev=608273&r1=608272&r2=608273&view=diff
==============================================================================
---
incubator/cxf/branches/2.0.x-fixes/api/src/main/java/org/apache/cxf/databinding/DataReader.java
(original)
+++
incubator/cxf/branches/2.0.x-fixes/api/src/main/java/org/apache/cxf/databinding/DataReader.java
Wed Jan 2 14:48:49 2008
@@ -31,10 +31,53 @@
String FAULT = DataReader.class.getName() + "Fault";
String ENDPOINT = DataReader.class.getName() + "Endpoint";
+ /**
+ * 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
+ * [EMAIL PROTECTED] #read(Object)}.
+ * @param input input source object.
+ * @return item read.
+ */
Object read(MessagePartInfo part, T input);
- Object read(QName name, T input, Class type);
+ /**
+ * 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);
+ /**
+ * Supply a schema to validate the input. Bindings silently ignore this
parameter if they
+ * do not support schema validation, or the particular form of validation
implied by
+ * a particular form of Schema.
+ * @param s
+ */
void setSchema(Schema s);
+ /**
+ * Attach a collection of attachments to a binding. This permits a binding
to process the contents
+ * of one or more attachments as part of reading from this reader.
+ * @param attachments attachments.
+ */
void setAttachments(Collection<Attachment> attachments);
+ /**
+ * Set an arbitrary property on the reader.
+ * [EMAIL PROTECTED] #FAULT} and [EMAIL PROTECTED] #ENDPOINT} specify two
common properties: the Fault object being read
+ * and the [EMAIL PROTECTED] org.apache.cxf.endpoint.Endpoint}.
+ * @param prop Name of the property.
+ * @param value Value of the property.
+ */
void setProperty(String prop, Object value);
}
