abdera-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jmsn...@apache.org
Subject svn commit: r436930 - in /incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera: factory/Factory.java filter/ListParseFilter.java filter/TextFilter.java parser/Parser.java
Date Fri, 25 Aug 2006 20:28:06 GMT
Author: jmsnell
Date: Fri Aug 25 13:28:05 2006
New Revision: 436930

URL: http://svn.apache.org/viewvc?rev=436930&view=rev
Log:
Javadoc Fixes. Factory and Parser still showed the old nnn.INSTANCE API. 
ListParseFilter and TextFilter needed some javadocs

Modified:
    incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/factory/Factory.java
    incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/filter/ListParseFilter.java
    incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/filter/TextFilter.java
    incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/parser/Parser.java

Modified: incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/factory/Factory.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/factory/Factory.java?rev=436930&r1=436929&r2=436930&view=diff
==============================================================================
--- incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/factory/Factory.java
(original)
+++ incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/factory/Factory.java
Fri Aug 25 13:28:05 2006
@@ -48,10 +48,6 @@
  * Users will generally not have to know anything about the Factory 
  * implementation, which will be automatically selected based on the
  * Abdera configuration options.
- * 
- * <p>
- *   <code>Factory factory = Factory.INSTANCE;</code>
- * </p>
  */
 public interface Factory {
 

Modified: incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/filter/ListParseFilter.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/filter/ListParseFilter.java?rev=436930&r1=436929&r2=436930&view=diff
==============================================================================
--- incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/filter/ListParseFilter.java
(original)
+++ incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/filter/ListParseFilter.java
Fri Aug 25 13:28:05 2006
@@ -21,12 +21,24 @@
 
 public interface ListParseFilter extends ParseFilter {
 
+  /**
+   * Add an element QName to the parse filter
+   */
   public abstract void add(QName qname);
 
+  /**
+   * Returns true if the given qname has been added to the filter
+   */
   public abstract boolean contains(QName qname);
 
+  /**
+   * Adds an attribute to the parse filter
+   */
   public abstract void add(QName parent, QName attribute);
 
+  /**
+   * Returns true if the given attribute has been added to the filter
+   */
   public abstract boolean contains(QName qname, QName attribute);
   
 }

Modified: incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/filter/TextFilter.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/filter/TextFilter.java?rev=436930&r1=436929&r2=436930&view=diff
==============================================================================
--- incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/filter/TextFilter.java
(original)
+++ incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/filter/TextFilter.java
Fri Aug 25 13:28:05 2006
@@ -30,12 +30,20 @@
 
   public Object clone() throws CloneNotSupportedException;
   
+  /**
+   * Applies the text filter to the specified element text, 
+   * returns the filtered text
+   */
   public String applyFilter(
     char[] c, 
     int start, 
     int len, 
     Element parent);
   
+  /**
+   * Applies the text filter to the specified attribute text, 
+   * returns the filtered text
+   */
   public String applyFilter(
     String value, 
     Element parent,

Modified: incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/parser/Parser.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/parser/Parser.java?rev=436930&r1=436929&r2=436930&view=diff
==============================================================================
--- incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/parser/Parser.java (original)
+++ incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/parser/Parser.java Fri
Aug 25 13:28:05 2006
@@ -26,11 +26,7 @@
 import org.apache.abdera.model.Element;
 
 /**
- * The Parser is the interface through which developers parse feed documents.
- * 
- * <p>
- *   <code>Document doc = Parser.INSTANCE.parse(inputStream, baseUri, options);</code>
- * </p>
+ * The Parser is the interface through which developers parse feed documents. 
  */
 public interface Parser {
   



Mime
View raw message