cocoon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From p...@apache.org
Subject svn commit: r279184 - in /cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation: Schema.java SchemaParser.java impl/AbstractSchema.java impl/JingContext.java impl/JingSchemaParser.java
Date Tue, 06 Sep 2005 23:52:57 GMT
Author: pier
Date: Tue Sep  6 16:52:51 2005
New Revision: 279184

URL: http://svn.apache.org/viewcvs?rev=279184&view=rev
Log:
JavaDOC warnings fixes

Modified:
    cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/Schema.java
    cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/SchemaParser.java
    cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/impl/AbstractSchema.java
    cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/impl/JingContext.java
    cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/impl/JingSchemaParser.java

Modified: cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/Schema.java
URL: http://svn.apache.org/viewcvs/cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/Schema.java?rev=279184&r1=279183&r2=279184&view=diff
==============================================================================
--- cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/Schema.java
(original)
+++ cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/Schema.java
Tue Sep  6 16:52:51 2005
@@ -15,7 +15,6 @@
  */
 package org.apache.cocoon.components.validation;
 
-import org.apache.excalibur.source.Source;
 import org.apache.excalibur.source.SourceValidity;
 import org.apache.excalibur.xml.sax.XMLConsumer;
 import org.xml.sax.ErrorHandler;
@@ -34,11 +33,9 @@
     /**
      * <p>Return the {@link SourceValidity} associated with this {@link Schema}.</p>
      * 
-     * <p>Schema implementations might return simple schema implementations as
-     * returned by {@link Source#getValidity()}, but if the current schema language
-     * allow inclusion of sub-schemas, the {@link SourceValidity} returned by this
-     * method <b>must</b> validate the original schema {@link Source} <b>and</b>
all
-     * its sub-schema {@link Source}s.</p>
+     * <p>If the current schema language allow inclusion of sub-schemas, the
+     * {@link SourceValidity} returned by this method <b>must</b> validate both
the
+     * original schema URI <b>and</b> all its sub-schemas.</p>
      * 
      * @return a {@link SourceValidity} instance or <b>null</b> if not known.
      */
@@ -69,7 +66,7 @@
      * 
      * <p>Once used, the returned {@link XMLConsumer} <b>can not</b> be
reused.</p> 
      * 
-     * @param errorHandler an {@link ErrorHandler} to notify of validation errors.
+     * @param handler an {@link ErrorHandler} to notify of validation errors.
      * @return a <b>non-null</b> {@link XMLConsumer} instance.
      */
     public XMLConsumer newValidator(ErrorHandler handler);

Modified: cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/SchemaParser.java
URL: http://svn.apache.org/viewcvs/cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/SchemaParser.java?rev=279184&r1=279183&r2=279184&view=diff
==============================================================================
--- cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/SchemaParser.java
(original)
+++ cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/SchemaParser.java
Tue Sep  6 16:52:51 2005
@@ -18,9 +18,6 @@
 import java.io.IOException;
 
 import org.apache.avalon.framework.thread.ThreadSafe;
-import org.apache.excalibur.source.Source;
-import org.apache.excalibur.source.SourceValidity;
-import org.xml.sax.ErrorHandler;
 import org.xml.sax.SAXException;
 
 /**
@@ -29,8 +26,7 @@
  * 
  * <p>This interface does not imply any requirement in terms of the language used
  * to produce {@link Schema} instances. Normally multiple-language selection is
- * provided looking up the {@link SELECTOR} role, and from there determining
- * the implementation required.</p>
+ * provided through the {@link Validator} class.</p>
  * 
  * <p>The only requirement imposed by this interface is that the final class
  * implementing this interface must be {@link ThreadSafe}.</p>
@@ -47,18 +43,12 @@
      * 
      * <p>Once parsed, the returned {@link Schema} can be used multiple time to
      * validate documents by sending their SAX events to the handler returned by
-     * the {@link Schema#createXMLConsumer(ErrorHandler)}.</p>
+     * the {@link Schema#newValidator()}.</p>
      * 
-     * <p>As different schema languages allow inclusion of sub-schemas, the
-     * {@link SourceValidity} of the resolved schema might not equivalent to the
-     * one returned by {@link Source#getValidity()}. After parsing is complete, the
-     * validity of the parsed schema and its sub-schemas is available calling the 
-     * {@link Schema#getValidity()} method.</p>
-     *
-     * @param source the {@link Source} of the {@link Schema} to return.
+     * @param uri the URI of the {@link Schema} to return.
      * @return a <b>non-null</b> {@link Schema} instance.
-     * @throws SAXException if an error occurred parsing the {@link Source}.
-     * @throws IOException if an I/O error occurred parsing the {@link Source}.
+     * @throws SAXException if an error occurred parsing the schema.
+     * @throws IOException if an I/O error occurred parsing the schema.
      */
     public Schema getSchema(String uri)
     throws SAXException, IOException;

Modified: cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/impl/AbstractSchema.java
URL: http://svn.apache.org/viewcvs/cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/impl/AbstractSchema.java?rev=279184&r1=279183&r2=279184&view=diff
==============================================================================
--- cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/impl/AbstractSchema.java
(original)
+++ cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/impl/AbstractSchema.java
Tue Sep  6 16:52:51 2005
@@ -18,7 +18,6 @@
 package org.apache.cocoon.components.validation.impl;
 
 import org.apache.cocoon.components.validation.Schema;
-import org.apache.excalibur.source.Source;
 import org.apache.excalibur.source.SourceValidity;
 import org.apache.excalibur.xml.sax.XMLConsumer;
 import org.xml.sax.ErrorHandler;
@@ -26,7 +25,7 @@
 import org.xml.sax.SAXParseException;
 
 /**
- * <p>A simple implementation of the {@link Scema} interface.</p>
+ * <p>A simple implementation of the {@link Schema} interface.</p>
  *
  * @author <a href="mailto:pier@betaversion.org">Pier Fumagalli</a>
  */
@@ -43,12 +42,6 @@
 
     /**
      * <p>Return the {@link SourceValidity} associated with this {@link Schema}.</p>
-     * 
-     * <p>Schema implementations might return simple schema implementations as
-     * returned by {@link Source#getValidity()}, but if the current schema language
-     * allow inclusion of sub-schemas, the {@link SourceValidity} returned by this
-     * method <b>must</b> validate the original schema {@link Source} <b>and</b>
all
-     * its sub-schema {@link Source}s.</p>
      * 
      * @return a {@link SourceValidity} instance or <b>null</b> if not known.
      */

Modified: cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/impl/JingContext.java
URL: http://svn.apache.org/viewcvs/cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/impl/JingContext.java?rev=279184&r1=279183&r2=279184&view=diff
==============================================================================
--- cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/impl/JingContext.java
(original)
+++ cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/impl/JingContext.java
Tue Sep  6 16:52:51 2005
@@ -179,7 +179,7 @@
      * {@link Stack} of {@link InputSource}s kept for URI resolution as explained
      * in the description of the {@link #resolveEntity(String, String)} method.</p>
      * 
-     * @see JingReader
+     * @link JingReader
      * @return a <b>non-null</b> {@link XMLReader} instance.
      * @throws SAXException if an error occurrent creating the {@link XMLReader}.
      */

Modified: cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/impl/JingSchemaParser.java
URL: http://svn.apache.org/viewcvs/cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/impl/JingSchemaParser.java?rev=279184&r1=279183&r2=279184&view=diff
==============================================================================
--- cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/impl/JingSchemaParser.java
(original)
+++ cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/impl/JingSchemaParser.java
Tue Sep  6 16:52:51 2005
@@ -21,7 +21,6 @@
 import org.apache.cocoon.components.validation.Schema;
 import org.apache.cocoon.components.validation.SchemaParser;
 import org.apache.cocoon.components.validation.Validator;
-import org.apache.excalibur.source.Source;
 import org.xml.sax.InputSource;
 import org.xml.sax.SAXException;
 
@@ -55,10 +54,10 @@
     /**
      * <p>Parse the specified URI and return a {@link Schema}.</p>
      *
-     * @param source the {@link Source} of the {@link Schema} to return.
+     * @param uri the URI of the {@link Schema} to return.
      * @return a <b>non-null</b> {@link Schema} instance.
-     * @throws SAXException if an error occurred parsing the {@link Source}.
-     * @throws IOException if an I/O error occurred parsing the {@link Source}.
+     * @throws SAXException if an error occurred parsing the schema.
+     * @throws IOException if an I/O error occurred parsing the schema.
      */
     public Schema parseSchema(String uri)
     throws SAXException, IOException {



Mime
View raw message