abdera-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jmsn...@apache.org
Subject svn commit: r559721 - in /incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model: Attribute.java Comment.java ProcessingInstruction.java TextValue.java
Date Thu, 26 Jul 2007 07:00:23 GMT
Author: jmsnell
Date: Thu Jul 26 00:00:22 2007
New Revision: 559721

URL: http://svn.apache.org/viewvc?view=rev&rev=559721
Log:
Javadocs

Modified:
    incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Attribute.java
    incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Comment.java
    incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/ProcessingInstruction.java
    incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/TextValue.java

Modified: incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Attribute.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Attribute.java?view=diff&rev=559721&r1=559720&r2=559721
==============================================================================
--- incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Attribute.java
(original)
+++ incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Attribute.java
Thu Jul 26 00:00:22 2007
@@ -21,14 +21,30 @@
 
 import org.apache.abdera.factory.Factory;
 
+/**
+ * An attribute. Returned by the Abdera XPath implementation
+ * when querying for Attribute nodes
+ */
 public interface Attribute {
 
+  /**
+   * The QName of the attribute
+   */
   QName getQName();
   
+  /**
+   * The text value of the attribute
+   */
   String getText();
   
+  /**
+   * The text value of the attribute
+   */
   void setText(String text);
   
+  /**
+   * The Abdera Factory
+   */
   Factory getFactory();
   
 }

Modified: incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Comment.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Comment.java?view=diff&rev=559721&r1=559720&r2=559721
==============================================================================
--- incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Comment.java (original)
+++ incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/Comment.java Thu
Jul 26 00:00:22 2007
@@ -19,15 +19,34 @@
 
 import org.apache.abdera.factory.Factory;
 
+/**
+ * A comment. Returned by the Abdera XPath implementation when querying for
+ * comment nodes (e.g. xpath.selectNodes("//comment()"); ...)
+ */
 public interface Comment {
 
+  /**
+   * Delete the comment node
+   */
   void discard();
   
+  /**
+   * The text of this comment node
+   */
   String getText();
   
+  /**
+   * The text of this comment node
+   */
   void setText(String text);
   
+  /**
+   * The Abdera Factory
+   */
   Factory getFactory();
   
+  /**
+   * The parent node
+   */
   <T extends Base>T getParentElement();
 }

Modified: incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/ProcessingInstruction.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/ProcessingInstruction.java?view=diff&rev=559721&r1=559720&r2=559721
==============================================================================
--- incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/ProcessingInstruction.java
(original)
+++ incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/ProcessingInstruction.java
Thu Jul 26 00:00:22 2007
@@ -19,20 +19,45 @@
 
 import org.apache.abdera.factory.Factory;
 
+/**
+ * A processing instruction. Returned by the Abdera XPath implementation when querying for
+ * PI nodes (e.g. xpath.selectNodes("//processing-instruction()"); ...)
+ */
 public interface ProcessingInstruction {
 
+  /**
+   * Delete this PI
+   */
   void discard();
   
+  /**
+   * The Abdera Factory
+   */
   Factory getFactory();
   
+  /**
+   * The parent node
+   */
   <T extends Base>T getParentElement();
   
+  /**
+   * The PI target
+   */
   String getTarget();
   
+  /**
+   * The PI target
+   */
   void setTarget(String target);
   
+  /**
+   * The PI text
+   */
   String getText();
   
+  /**
+   * The PI text
+   */
   void setText(String text);
   
 }

Modified: incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/TextValue.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/TextValue.java?view=diff&rev=559721&r1=559720&r2=559721
==============================================================================
--- incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/TextValue.java
(original)
+++ incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/model/TextValue.java
Thu Jul 26 00:00:22 2007
@@ -21,16 +21,35 @@
 
 import javax.activation.DataHandler;
 
+/**
+ * A text value. Returned by the Abdera XPath implementation when querying for
+ * text nodes (e.g. xpath.selectNodes("//text()"); ...)
+ */
 public interface TextValue {
 
+  /**
+   * A DataHandler for Base64 encoded binary data
+   */
   DataHandler getDataHandler();
   
+  /**
+   * An InputStream used to read the text content
+   */
   InputStream getInputStream();
   
+  /**
+   * Return the text value
+   */
   String getText();
   
+  /**
+   * The parent element
+   */
   <T extends Base>T getParentElement();
   
+  /**
+   * Delete this node
+   */
   void discard();
   
 }



Mime
View raw message