svn commit: r607622 - /incubator/cxf/trunk/api/src/main/java/org/apache/cxf/databinding/DataReader.java

[bi...@apache.org]

Author: bimargulies
Date: Sun Dec 30 15:56:34 2007
New Revision: 607622

URL: http://svn.apache.org/viewvc?rev=607622&view=rev
Log:
Add javadoc.

Modified:
    incubator/cxf/trunk/api/src/main/java/org/apache/cxf/databinding/DataReader.java

Modified: incubator/cxf/trunk/api/src/main/java/org/apache/cxf/databinding/DataReader.java
URL: http://svn.apache.org/viewvc/incubator/cxf/trunk/api/src/main/java/org/apache/cxf/databinding/DataReader.java?rev=607622&r1=607621&r2=607622&view=diff
==============================================================================
--- incubator/cxf/trunk/api/src/main/java/org/apache/cxf/databinding/DataReader.java (original)
+++ incubator/cxf/trunk/api/src/main/java/org/apache/cxf/databinding/DataReader.java Sun Dec 30 15:56:34 2007
@@ -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
+     * {@link #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.
+     * {@link #FAULT} and {@link #ENDPOINT} specify two common properties: the Fault object being read
+     * and the {@link org.apache.cxf.endpoint.Endpoint}.
+     * @param prop Name of the property.
+     * @param value Value of the property.
+     */
     void setProperty(String prop, Object value);
 }