This is an automated email from the ASF dual-hosted git repository.
elharo pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/xerces-j.git
The following commit(s) were added to refs/heads/main by this push:
new 2591aaafd [XERCESJ-1781] fix Javadoc warnings (#48)
2591aaafd is described below
commit 2591aaafdfb263929ce83874ebafe8ee4adb2855
Author: Samael <[email protected]>
AuthorDate: Mon Nov 17 19:10:45 2025 +0000
[XERCESJ-1781] fix Javadoc warnings (#48)
* [XERCESJ-1781] fix Javadoc warnings
* [XERCESJ-1781] changes for PR review
* [XERCESJ-1781] changes for PR review
---
src/org/apache/xerces/impl/dv/XSSimpleType.java | 27 ++---
.../apache/xerces/impl/xs/XSComplexTypeDecl.java | 6 +-
.../xerces/jaxp/DocumentBuilderFactoryImpl.java | 9 +-
.../apache/xerces/jaxp/DocumentBuilderImpl.java | 24 ++++-
src/org/apache/xerces/parsers/DTDParser.java | 6 +-
.../apache/xerces/parsers/XMLGrammarParser.java | 4 +-
src/org/apache/xerces/xni/XMLString.java | 5 +-
src/org/apache/xerces/xni/grammars/XSGrammar.java | 11 +-
.../xerces/xni/parser/XMLParseException.java | 15 ++-
.../xerces/xni/parser/XMLParserConfiguration.java | 37 +++++--
src/org/apache/xerces/xs/AttributePSVI.java | 8 +-
src/org/apache/xerces/xs/ElementPSVI.java | 19 +++-
src/org/apache/xerces/xs/ItemPSVI.java | 92 +++++++++++------
src/org/apache/xerces/xs/LSInputList.java | 18 ++--
src/org/apache/xerces/xs/ShortList.java | 35 ++++---
src/org/apache/xerces/xs/StringList.java | 34 +++---
src/org/apache/xerces/xs/XSAnnotation.java | 17 +--
.../apache/xerces/xs/XSAttributeDeclaration.java | 82 +++++++++------
.../xerces/xs/XSAttributeGroupDefinition.java | 14 ++-
src/org/apache/xerces/xs/XSAttributeUse.java | 41 +++++---
.../apache/xerces/xs/XSComplexTypeDefinition.java | 54 +++++++---
src/org/apache/xerces/xs/XSElementDeclaration.java | 115 +++++++++++++++------
src/org/apache/xerces/xs/XSTypeDefinition.java | 65 +++++++-----
src/org/apache/xerces/xs/datatypes/ByteList.java | 32 +++---
src/org/apache/xerces/xs/datatypes/ObjectList.java | 26 ++---
src/org/apache/xerces/xs/datatypes/XSDateTime.java | 55 +++++++---
src/org/apache/xerces/xs/datatypes/XSDecimal.java | 14 ++-
src/org/apache/xerces/xs/datatypes/XSDouble.java | 4 +-
src/org/apache/xerces/xs/datatypes/XSFloat.java | 4 +-
src/org/apache/xerces/xs/datatypes/XSQName.java | 4 +
.../apache/xml/serialize/SerializerFactory.java | 28 ++++-
31 files changed, 609 insertions(+), 296 deletions(-)
diff --git a/src/org/apache/xerces/impl/dv/XSSimpleType.java
b/src/org/apache/xerces/impl/dv/XSSimpleType.java
index fb7e74a1a..d79ab1dc2 100644
--- a/src/org/apache/xerces/impl/dv/XSSimpleType.java
+++ b/src/org/apache/xerces/impl/dv/XSSimpleType.java
@@ -23,8 +23,10 @@ import org.apache.xerces.xs.XSSimpleTypeDefinition;
* This interface <code>XSSimpleType</code> represents the simple type
* definition of schema component and defines methods to query the information
* contained.
+ * <p>
* Any simple type (atomic, list or union) will implement this interface.
* It inherits from <code>XSTypeDecl</code>.
+ * </p>
*
* @xerces.internal
*
@@ -34,11 +36,12 @@ import org.apache.xerces.xs.XSSimpleTypeDefinition;
*/
public interface XSSimpleType extends XSSimpleTypeDefinition {
- /**
+ /*
* constants defined for the values of 'whitespace' facet.
* see <a href='http://www.w3.org/TR/xmlschema-2/#dt-whiteSpace'> XML
Schema
* Part 2: Datatypes </a>
*/
+
/** preserve the white spaces */
public static final short WS_PRESERVE = 0;
/** replace the white spaces */
@@ -46,11 +49,12 @@ public interface XSSimpleType extends
XSSimpleTypeDefinition {
/** collapse the white spaces */
public static final short WS_COLLAPSE = 2;
- /**
+ /*
* Constant defined for the primitive built-in simple tpyes.
* see <a
href='http://www.w3.org/TR/xmlschema-2/#built-in-primitive-datatypes'>
* XML Schema Part 2: Datatypes </a>
*/
+
/** "string" type */
public static final short PRIMITIVE_STRING = 1;
/** "boolean" type */
@@ -144,12 +148,12 @@ public interface XSSimpleType extends
XSSimpleTypeDefinition {
* different facets.
*
* @param facets the value of all the facets
- * @param presentFacet bit combination value of the costraining facet
- * constants which are present.
- * @param fixedFacet bit combination value of the costraining facet
- * constants which are fixed.
+ * @param presentFacet bit-combination value of the constraining facet
+ * constants which are present
+ * @param fixedFacet bit-combination value of the constraining facet
+ * constants which are fixed
* @param context the validation context
- * @exception InvalidDatatypeFacetException exception for invalid facet
values.
+ * @throws InvalidDatatypeFacetException exception for invalid facet values
*/
public void applyFacets(XSFacets facets, short presentFacet, short
fixedFacet, ValidationContext context)
throws InvalidDatatypeFacetException;
@@ -163,7 +167,7 @@ public interface XSSimpleType extends
XSSimpleTypeDefinition {
*/
public boolean isEqual(Object value1, Object value2);
- /**
+ /*
* Check the order of the two actual values. (May not be supported by all
* simple types.
* REVISIT: Andy believes that a compare() method is necessary.
@@ -192,10 +196,9 @@ public interface XSSimpleType extends
XSSimpleTypeDefinition {
/**
* Return the whitespace corresponding to this datatype.
- *
- * @return valid values are WS_PRESERVE, WS_REPLACE, WS_COLLAPSE.
- * @exception DatatypeException
- * union datatypes don't have whitespace facet
associated with them
+ *
+ * @return either {@link #WS_PRESERVE}, {@link #WS_REPLACE}, or {@link
#WS_COLLAPSE}.
+ * @throws DatatypeException union datatypes don't have whitespace facet
associated with them
*/
public short getWhitespace() throws DatatypeException;
}
diff --git a/src/org/apache/xerces/impl/xs/XSComplexTypeDecl.java
b/src/org/apache/xerces/impl/xs/XSComplexTypeDecl.java
index aa40ae97f..91a5994a0 100644
--- a/src/org/apache/xerces/impl/xs/XSComplexTypeDecl.java
+++ b/src/org/apache/xerces/impl/xs/XSComplexTypeDecl.java
@@ -599,7 +599,11 @@ public class XSComplexTypeDecl implements
XSComplexTypeDefinition, TypeInfo {
/**
* {derivation method} Either extension or restriction. The valid constant
- * value for this <code>XSConstants</code> EXTENTION, RESTRICTION.
+ * value for this <code>XSConstants</code> EXTENSION, RESTRICTION.
+ *
+ * @return the derivation method as a short
+ * @see XSConstants#DERIVATION_EXTENSION
+ * @see XSConstants#DERIVATION_RESTRICTION
*/
public short getDerivationMethod() {
return fDerivedBy;
diff --git a/src/org/apache/xerces/jaxp/DocumentBuilderFactoryImpl.java
b/src/org/apache/xerces/jaxp/DocumentBuilderFactoryImpl.java
index c40ccc004..30d9ff0af 100644
--- a/src/org/apache/xerces/jaxp/DocumentBuilderFactoryImpl.java
+++ b/src/org/apache/xerces/jaxp/DocumentBuilderFactoryImpl.java
@@ -33,6 +33,8 @@ import org.xml.sax.SAXNotRecognizedException;
import org.xml.sax.SAXNotSupportedException;
/**
+ * An implementation of DocumentBuilderFactory.
+ *
* @author Rajiv Mordani
* @author Edwin Goei
* @version $Id$
@@ -145,8 +147,11 @@ public class DocumentBuilderFactoryImpl extends
DocumentBuilderFactory {
}
/**
- * Allows the user to retrieve specific attributes on the underlying
- * implementation.
+ * Allows the user to retrieve specific attributes on the underlying
implementation.
+ *
+ * @param name the name of attribute
+ * @return the requested attribute
+ * @throws IllegalArgumentException if no property or feature is found for
the provided name
*/
public Object getAttribute(String name)
throws IllegalArgumentException
diff --git a/src/org/apache/xerces/jaxp/DocumentBuilderImpl.java
b/src/org/apache/xerces/jaxp/DocumentBuilderImpl.java
index bb2305254..817f898eb 100644
--- a/src/org/apache/xerces/jaxp/DocumentBuilderImpl.java
+++ b/src/org/apache/xerces/jaxp/DocumentBuilderImpl.java
@@ -49,6 +49,8 @@ import org.xml.sax.SAXNotRecognizedException;
import org.xml.sax.SAXNotSupportedException;
/**
+ * A DocumentBuilder that can be used to create a DOM Document from XML.
+ *
* @author Rajiv Mordani
* @author Edwin Goei
* @version $Id$
@@ -214,11 +216,15 @@ public class DocumentBuilderImpl extends DocumentBuilder
}
/**
- * Set any DocumentBuilderFactory attributes of our underlying DOMParser
+ * Set any DocumentBuilderFactory attributes of our underlying DOMParser.
*
+ * <p>
* Note: code does not handle possible conflicts between DOMParser
* attribute names and JAXP specific attribute names,
- * eg. DocumentBuilderFactory.setValidating()
+ * eg; {@link
javax.xml.parsers.DocumentBuilderFactory#setValidating(boolean)}
+ * </p>
+ *
+ * @param dbfAttrs attributes to set on the underlying DOMParser
*/
private void setDocumentBuilderFactoryAttributes(Hashtable dbfAttrs)
throws SAXNotSupportedException, SAXNotRecognizedException
@@ -301,6 +307,12 @@ public class DocumentBuilderImpl extends DocumentBuilder
return doc;
}
+ /**
+ * Indicates whether or not this parser is configured to understand
namespaces.
+ *
+ * @return true if this parser is configured to understand namespaces;
false otherwise
+ * @see #NAMESPACES_FEATURE
+ */
public boolean isNamespaceAware() {
try {
return domParser.getFeature(NAMESPACES_FEATURE);
@@ -320,8 +332,10 @@ public class DocumentBuilderImpl extends DocumentBuilder
}
/**
- * Gets the XInclude processing mode for this parser
+ * Gets the XInclude processing mode for this parser.
+ *
* @return the state of XInclude processing mode
+ * @see #XINCLUDE_FEATURE
*/
public boolean isXIncludeAware() {
try {
@@ -345,11 +359,11 @@ public class DocumentBuilderImpl extends DocumentBuilder
}
public void reset() {
- /** Restore the initial error handler. **/
+ /* Restore the initial error handler. */
if (domParser.getErrorHandler() != fInitErrorHandler) {
domParser.setErrorHandler(fInitErrorHandler);
}
- /** Restore the initial entity resolver. **/
+ /* Restore the initial entity resolver. */
if (domParser.getEntityResolver() != fInitEntityResolver) {
domParser.setEntityResolver(fInitEntityResolver);
}
diff --git a/src/org/apache/xerces/parsers/DTDParser.java
b/src/org/apache/xerces/parsers/DTDParser.java
index 8efc32016..e10b60a1e 100644
--- a/src/org/apache/xerces/parsers/DTDParser.java
+++ b/src/org/apache/xerces/parsers/DTDParser.java
@@ -29,6 +29,8 @@ import org.apache.xerces.xni.XNIException;
import org.apache.xerces.xni.parser.XMLDTDScanner;
/**
+ * A base DTD Parser class that can be extended when needing to parse a
Document Type Definition
+ *
* @version $Id$
*/
public abstract class DTDParser
@@ -47,9 +49,9 @@ public abstract class DTDParser
//
/**
+ * Construct a DTDParser with the specified symbol table
*
- *
- * @param symbolTable
+ * @param symbolTable the symbol table to use
*/
public DTDParser(SymbolTable symbolTable) {
super(symbolTable);
diff --git a/src/org/apache/xerces/parsers/XMLGrammarParser.java
b/src/org/apache/xerces/parsers/XMLGrammarParser.java
index 781d6618f..7c9ba0e0c 100644
--- a/src/org/apache/xerces/parsers/XMLGrammarParser.java
+++ b/src/org/apache/xerces/parsers/XMLGrammarParser.java
@@ -23,6 +23,8 @@ import org.apache.xerces.util.SymbolTable;
import org.apache.xerces.xni.parser.XMLParserConfiguration;
/**
+ * A base XML Grammar Parser class that can be extended for parsing XML
+ *
* @version $Id$
*/
public abstract class XMLGrammarParser
@@ -42,7 +44,7 @@ public abstract class XMLGrammarParser
/**
* Construct an XMLGrammarParser with the specified symbol table
*
- * @param symbolTable
+ * @param symbolTable the symbol table to use
*/
protected XMLGrammarParser(SymbolTable symbolTable) {
super((XMLParserConfiguration)ObjectFactory.createObject(
diff --git a/src/org/apache/xerces/xni/XMLString.java
b/src/org/apache/xerces/xni/XMLString.java
index bfa8661d4..649033f72 100644
--- a/src/org/apache/xerces/xni/XMLString.java
+++ b/src/org/apache/xerces/xni/XMLString.java
@@ -154,8 +154,9 @@ public class XMLString {
/**
* Returns true if the contents of this XMLString structure and
* the specified string are equal.
- *
- * @param s The string to compare.
+ *
+ * @param s the Java string to compare
+ * @return true if the contents of this XMLString match the string
*/
public boolean equals(String s) {
if (s == null) {
diff --git a/src/org/apache/xerces/xni/grammars/XSGrammar.java
b/src/org/apache/xerces/xni/grammars/XSGrammar.java
index 5a932c7bd..add0ac7d5 100644
--- a/src/org/apache/xerces/xni/grammars/XSGrammar.java
+++ b/src/org/apache/xerces/xni/grammars/XSGrammar.java
@@ -37,16 +37,17 @@ public interface XSGrammar extends Grammar {
* grammar and any schema grammars that are imported by this grammar
* directly or indirectly.
*
- * @return an <code>XSModel</code> representing this schema grammar
+ * @return an <code>XSModel</code> representing this schema grammar
*/
public XSModel toXSModel();
-
+
/**
* Return an <code>XSModel</code> that represents components in this schema
- * grammar and the grammars in the <code>grammars</code>parameter,
+ * grammar and the grammars in the <code>grammars</code> parameter,
* any schema grammars that are imported by them directly or indirectly.
- *
- * @return an <code>XSModel</code> representing these schema grammars
+ *
+ * @param grammars other <code>XSGrammar</code> that will make up the
returned <code>XSModel</code>
+ * @return an <code>XSModel</code> representing these schema grammars
*/
public XSModel toXSModel(XSGrammar[] grammars);
diff --git a/src/org/apache/xerces/xni/parser/XMLParseException.java
b/src/org/apache/xerces/xni/parser/XMLParseException.java
index 1610fc509..37c833ac9 100644
--- a/src/org/apache/xerces/xni/parser/XMLParseException.java
+++ b/src/org/apache/xerces/xni/parser/XMLParseException.java
@@ -64,7 +64,12 @@ public class XMLParseException
// Constructors
//
- /** Constructs a parse exception. */
+ /**
+ * Constructs an XML parse exception with an <code>XMLLocator</code> and a
message.
+ *
+ * @param locator an <code>XMLLocator</code>
+ * @param message the exception message
+ */
public XMLParseException(XMLLocator locator, String message) {
super(message);
if (locator != null) {
@@ -78,7 +83,13 @@ public class XMLParseException
}
} // <init>(XMLLocator,String)
- /** Constructs a parse exception. */
+ /**
+ * Constructs an XML parse exception with an <code>XMLLocator</code>, a
message, and a wrapped exception.
+ *
+ * @param locator an <code>XMLLocator</code>
+ * @param message the exception message
+ * @param exception the wrapped exception
+ */
public XMLParseException(XMLLocator locator,
String message, Exception exception) {
super(message, exception);
diff --git a/src/org/apache/xerces/xni/parser/XMLParserConfiguration.java
b/src/org/apache/xerces/xni/parser/XMLParserConfiguration.java
index 964d13805..bc7700739 100644
--- a/src/org/apache/xerces/xni/parser/XMLParserConfiguration.java
+++ b/src/org/apache/xerces/xni/parser/XMLParserConfiguration.java
@@ -200,17 +200,25 @@ public interface XMLParserConfiguration
*/
public void setDocumentHandler(XMLDocumentHandler documentHandler);
- /** Returns the registered document handler. */
+ /**
+ * Returns the registered document handler.
+ *
+ * @return the registered document handler
+ */
public XMLDocumentHandler getDocumentHandler();
/**
* Sets the DTD handler.
*
- * @param dtdHandler The DTD handler.
+ * @param dtdHandler the DTD handler
*/
public void setDTDHandler(XMLDTDHandler dtdHandler);
- /** Returns the registered DTD handler. */
+ /**
+ * Returns the registered DTD handler.
+ *
+ * @return the registered DTD handler
+ */
public XMLDTDHandler getDTDHandler();
/**
@@ -220,7 +228,11 @@ public interface XMLParserConfiguration
*/
public void setDTDContentModelHandler(XMLDTDContentModelHandler
dtdContentModelHandler);
- /** Returns the registered DTD content model handler. */
+ /**
+ * Returns the registered DTD content model handler.
+ *
+ * @return the registered DTD content model handler
+ */
public XMLDTDContentModelHandler getDTDContentModelHandler();
// other settings
@@ -232,20 +244,27 @@ public interface XMLParserConfiguration
*/
public void setEntityResolver(XMLEntityResolver entityResolver);
- /** Returns the registered entity resolver. */
+ /**
+ * Returns the registered entity resolver.
+ *
+ * @return the registered entity resolver
+ */
public XMLEntityResolver getEntityResolver();
/**
* Set the locale to use for messages.
*
- * @param locale The locale object to use for localization of messages.
+ * @param locale the locale object to use for localization of messages
*
- * @exception XNIException Thrown if the parser does not support the
- * specified locale.
+ * @throws XNIException Thrown if the parser does not support the
specified locale
*/
public void setLocale(Locale locale) throws XNIException;
- /** Returns the locale. */
+ /**
+ * Returns the locale.
+ *
+ * @return the locale
+ */
public Locale getLocale();
} // interface XMLParserConfiguration
diff --git a/src/org/apache/xerces/xs/AttributePSVI.java
b/src/org/apache/xerces/xs/AttributePSVI.java
index 5e2b7dac1..560d0b7fb 100644
--- a/src/org/apache/xerces/xs/AttributePSVI.java
+++ b/src/org/apache/xerces/xs/AttributePSVI.java
@@ -18,12 +18,14 @@
package org.apache.xerces.xs;
/**
- * Represents a PSVI item for one attribute information item.
+ * Represents a PSVI item for one attribute information item.
*/
public interface AttributePSVI extends ItemPSVI {
+
/**
- * [attribute declaration]: An item isomorphic to the declaration
- * component itself.
+ * [attribute declaration]: An item isomorphic to the declaration
component itself.
+ *
+ * @return the Attribute Declaration for this attribute
*/
public XSAttributeDeclaration getAttributeDeclaration();
diff --git a/src/org/apache/xerces/xs/ElementPSVI.java
b/src/org/apache/xerces/xs/ElementPSVI.java
index af7f27933..ae1b9d987 100644
--- a/src/org/apache/xerces/xs/ElementPSVI.java
+++ b/src/org/apache/xerces/xs/ElementPSVI.java
@@ -18,29 +18,38 @@
package org.apache.xerces.xs;
/**
- * Represents a PSVI item for one element information item.
+ * Represents a PSVI item for one element information item.
*/
public interface ElementPSVI extends ItemPSVI {
+
/**
* [element declaration]: an item isomorphic to the element declaration
- * used to validate this element.
+ * used to validate this element.
+ *
+ * @return the element declaration
*/
public XSElementDeclaration getElementDeclaration();
/**
- * [notation]: the notation declaration.
+ * [notation]: the notation declaration.
+ *
+ * @return the notation declaration
*/
public XSNotationDeclaration getNotation();
/**
* [nil]: true if clause 3.2 of Element Locally Valid (Element) (3.3.4) is
- * satisfied, otherwise false.
+ * satisfied, otherwise false.
+ *
+ * @return true if nil
*/
public boolean getNil();
/**
* schema information: the schema information property if it is the
- * validation root, <code>null</code> otherwise.
+ * validation root, <code>null</code> otherwise.
+ *
+ * @return the schema information or null
*/
public XSModel getSchemaInformation();
diff --git a/src/org/apache/xerces/xs/ItemPSVI.java
b/src/org/apache/xerces/xs/ItemPSVI.java
index 3941a66d6..09f1ecf31 100644
--- a/src/org/apache/xerces/xs/ItemPSVI.java
+++ b/src/org/apache/xerces/xs/ItemPSVI.java
@@ -18,8 +18,7 @@
package org.apache.xerces.xs;
/**
- * Represents an abstract PSVI item for an element or an attribute
- * information item.
+ * Represents an abstract PSVI item for an element or an attribute information
item.
*/
public interface ItemPSVI {
/**
@@ -58,12 +57,16 @@ public interface ItemPSVI {
/**
* Returns a reference to an immutable instance with the same data
* that this instance of <code>ItemPSVI</code> currently has.
+ *
+ * @return a reference to an immutable instance with the same data that
this instance has
*/
public ItemPSVI constant();
/**
* Returns <code>true</code> if this specific instance of
* <code>ItemPSVI</code> is immutable, otherwise <code>false</code>.
+ *
+ * @return true if this specific instance of <code>ItemPSVI</code> is
immutable
*/
public boolean isConstant();
@@ -71,7 +74,10 @@ public interface ItemPSVI {
* The nearest ancestor element information item with a
* <code>[schema information]</code> property (or this element item
* itself if it has such a property). For more information refer to
- * element validation context and attribute validation context .
+ * element validation context and attribute validation context.
+ *
+ * @return the nearest ancestor element information item with a schema
+ * information property or this element item itself if it has such a
property
*/
public String getValidationContext();
@@ -79,7 +85,9 @@ public interface ItemPSVI {
* <code>[validity]</code>: determines the validity of the schema item
* with respect to the validation being attempted. The value will be one
* of the constants: <code>VALIDITY_NOTKNOWN</code>,
- * <code>VALIDITY_INVALID</code> or <code>VALIDITY_VALID</code>.
+ * <code>VALIDITY_INVALID</code> or <code>VALIDITY_VALID</code>.
+ *
+ * @return either {@link #VALIDITY_NOTKNOWN}, {@link #VALIDITY_INVALID},
or {@link #VALIDITY_VALID}
*/
public short getValidity();
@@ -87,14 +95,19 @@ public interface ItemPSVI {
* <code>[validation attempted]</code>: determines the extent to which
* the schema item has been validated. The value will be one of the
* constants: <code>VALIDATION_NONE</code>,
- * <code>VALIDATION_PARTIAL</code> or <code>VALIDATION_FULL</code>.
+ * <code>VALIDATION_PARTIAL</code> or <code>VALIDATION_FULL</code>.
+ *
+ * @return either {@link #VALIDATION_NONE}, {@link #VALIDATION_PARTIAL},
or {@link #VALIDATION_FULL}
*/
public short getValidationAttempted();
/**
* <code>[schema error code]</code>: a list of error codes generated from
* the validation attempt or an empty <code>StringList</code> if no
- * errors occurred during the validation attempt.
+ * errors occurred during the validation attempt.
+ *
+ * @return a list of error codes generated from the validation attempt
+ * or an empty <code>StringList</code>
*/
public StringList getErrorCodes();
@@ -103,13 +116,17 @@ public interface ItemPSVI {
* an empty <code>StringList</code> if no errors occurred during the
* validation attempt. The indices of error messages in this list are
* aligned with those in the <code>[schema error code]</code> list.
+ *
+ * @return a list of error messages generated from the validation attempt
+ * or an empty <code>StringList</code>
*/
public StringList getErrorMessages();
/**
* <code>[schema normalized value]</code>: the normalized value of this
* item after validation.
- *
+ *
+ * @return the schema normalized value
* @deprecated Use getSchemaValue().getNormalizedValue() instead
*/
@Deprecated
@@ -117,10 +134,11 @@ public interface ItemPSVI {
/**
* <code>[schema normalized value]</code>: Binding specific actual value
- * or <code>null</code> if the value is in error.
- * @exception XSException
- * NOT_SUPPORTED_ERR: Raised if the implementation does not support this
- * method.
+ * or <code>null</code> if the value is in error.
+ *
+ * @return the binding specific actual value or null
+ * @throws XSException NOT_SUPPORTED_ERR: Raised if the implementation
does not
+ * support this method
*
* @deprecated Use getSchemaValue().getActualValue() instead
*/
@@ -129,20 +147,23 @@ public interface ItemPSVI {
throws XSException;
/**
- * The actual value built-in datatype, e.g.
- * <code>STRING_DT, SHORT_DT</code>. If the type definition of this
+ * The actual value built-in datatype, e.g. {@link XSConstants#STRING_DT},
+ * {@link XSConstants#SHORT_DT}. If the type definition of this
* value is a list type definition, this method returns
- * <code>LIST_DT</code>. If the type definition of this value is a list
+ * {@link XSConstants#LIST_DT}. If the type definition of this value is a
list
* type definition whose item type is a union type definition, this
- * method returns <code>LISTOFUNION_DT</code>. To query the actual value
- * of the list or list of union type definitions use
- * <code>itemValueTypes</code>. If the <code>actualNormalizedValue</code>
- * is <code>null</code>, this method returns <code>UNAVAILABLE_DT</code>.
- * @exception XSException
- * NOT_SUPPORTED_ERR: Raised if the implementation does not support this
- * method.
+ * method returns {@link XSConstants#LISTOFUNION_DT}.
+ * <p>
+ * To query the actual value of the list or list of union type definitions
+ * use <code>itemValueTypes</code>. If the
<code>actualNormalizedValue</code>
+ * is <code>null</code>, this method returns {@link
XSConstants#UNAVAILABLE_DT}.
+ * </p>
+ *
+ * @return the actual value of the built-in datatype
+ * @throws XSException NOT_SUPPORTED_ERR: Raised if the implementation
does not
+ * support this method
*
- * @deprecated Use getSchemaValue().getActualValueType() instead
+ * @deprecated Use getSchemaValue().getActualValueType() instead
*/
@Deprecated
public short getActualNormalizedValueType()
@@ -174,12 +195,13 @@ public interface ItemPSVI {
* <code>schemaNormalizedValue</code> value is "1 2 foo", the
* <code>actualNormalizedValueType</code> is <code>LISTOFUNION_DT</code>
* , and the <code>itemValueTypes</code> is an array of size 3 with the
- * following values: <code>INTEGER_DT, INTEGER_DT, STRING_DT</code>.
- * @exception XSException
- * NOT_SUPPORTED_ERR: Raised if the implementation does not support this
+ * following values: <code>INTEGER_DT, INTEGER_DT, STRING_DT</code>.
+ *
+ * @return the item value types
+ * @throws XSException NOT_SUPPORTED_ERR: Raised if the implementation
does not support this
* method.
*
- * @deprecated Use getSchemaValue().getListValueTypes() instead
+ * @deprecated Use getSchemaValue().getListValueTypes() instead
*/
@Deprecated
public ShortList getItemValueTypes()
@@ -190,12 +212,16 @@ public interface ItemPSVI {
* content, then return the value with respect to the simple type. If
* this item doesn't have a simple-typed value, the behavior of this method
* is not specified.
+ *
+ * @return the value with respect to the simple type
*/
public XSValue getSchemaValue();
/**
* <code>[type definition]</code>: an item isomorphic to the type
- * definition used to validate the schema item.
+ * definition used to validate the schema item.
+ *
+ * @return the type definition
*/
public XSTypeDefinition getTypeDefinition();
@@ -205,21 +231,27 @@ public interface ItemPSVI {
* complex type definition whose {content type} is a simple type
* definition with {variety} union, then an item isomorphic to that
* member of the union's {member type definitions} which actually
- * validated the schema item's normalized value.
+ * validated the schema item's normalized value.
+ *
+ * @return the member type definition
*/
public XSSimpleTypeDefinition getMemberTypeDefinition();
/**
* <code>[schema default]</code>: the canonical lexical representation of
* the declaration's {value constraint} value. For more information
- * refer to element schema default and attribute schema default.
+ * refer to element schema default and attribute schema default.
+ *
+ * @return the canonical lexical representation of the declaration's
{value constraint} value
*/
public String getSchemaDefault();
/**
* <code>[schema specified]</code>: if true, the value was specified in
* the schema. If false, the value comes from the infoset. For more
- * information refer to element specified and attribute specified.
+ * information refer to element specified and attribute specified.
+ *
+ * @return true if the value was specified in the schema
*/
public boolean getIsSchemaSpecified();
diff --git a/src/org/apache/xerces/xs/LSInputList.java
b/src/org/apache/xerces/xs/LSInputList.java
index 7d3c7b8b7..556fe0bc9 100644
--- a/src/org/apache/xerces/xs/LSInputList.java
+++ b/src/org/apache/xerces/xs/LSInputList.java
@@ -22,25 +22,29 @@ import java.util.List;
import org.w3c.dom.ls.LSInput;
/**
- * The <code>LSInputList</code> interface provides the abstraction of an
+ * The <code>LSInputList</code> interface provides the abstraction of an
* ordered collection of <code>LSInput</code>s, without defining or
* constraining how this collection is implemented.
*/
public interface LSInputList extends List {
+
/**
- * The number of <code>LSInput</code>s in the list. The range of valid
- * child object indices is 0 to <code>length-1</code> inclusive.
+ * The number of <code>LSInput</code>s in the list. The range of valid
+ * child object indices is 0 to <code>length-1</code> inclusive.
+ *
+ * @return the number of <code>LSInput</code>s in the list
*/
public int getLength();
/**
- * Returns the <code>index</code>th item in the collection or
+ * Returns the <code>index</code>th item in the collection or
* <code>null</code> if <code>index</code> is greater than or equal to
- * the number of objects in the list. The index starts at 0.
- * @param index index into the collection.
+ * the number of objects in the list. The index starts at 0.
+ *
+ * @param index the index into the collection
* @return The <code>LSInput</code> at the <code>index</code>th
* position in the <code>LSInputList</code>, or <code>null</code> if
- * the index specified is not valid.
+ * the index specified is not valid.
*/
public LSInput item(int index);
diff --git a/src/org/apache/xerces/xs/ShortList.java
b/src/org/apache/xerces/xs/ShortList.java
index b26564cf2..0119668c8 100644
--- a/src/org/apache/xerces/xs/ShortList.java
+++ b/src/org/apache/xerces/xs/ShortList.java
@@ -20,35 +20,36 @@ package org.apache.xerces.xs;
import java.util.List;
/**
- * The <code>ShortList</code> is an immutable ordered collection of
- * <code>unsigned short</code>.
+ * The <code>ShortList</code> is an immutable ordered collection of
<code>unsigned short</code>.
*/
public interface ShortList extends List {
+
/**
- * The number of <code>unsigned short</code>s in the list. The range of
- * valid child object indices is 0 to <code>length-1</code> inclusive.
+ * The number of <code>unsigned short</code>s in the list. The range of
+ * valid child object indices is 0 to <code>length-1</code> inclusive.
+ *
+ * @return the number of shorts in the list
*/
public int getLength();
/**
- * Checks if the <code>unsigned short</code> <code>item</code> is a
- * member of this list.
- * @param item <code>unsigned short</code> whose presence in this list
+ * Checks if the <code>unsigned short</code> <code>item</code> is a member
of this list.
+ *
+ * @param item <code>unsigned short</code> whose presence in this list
* is to be tested.
- * @return True if this list contains the <code>unsigned short</code>
- * <code>item</code>.
+ * @return true if this list contains the <code>unsigned short</code>
<code>item</code>.
*/
public boolean contains(short item);
/**
- * Returns the <code>index</code>th item in the collection. The index
- * starts at 0.
- * @param index index into the collection.
- * @return The <code>unsigned short</code> at the <code>index</code>th
- * position in the <code>ShortList</code>.
- * @exception XSException
- * INDEX_SIZE_ERR: if <code>index</code> is greater than or equal to the
- * number of objects in the list.
+ * Returns the <code>index</code>th item in the collection. The index
starts at 0.
+ *
+ * @param index the index into the collection.
+ * @return the <code>unsigned short</code> at the <code>index</code>th
+ * position in the <code>ShortList</code>.
+ *
+ * @throws XSException INDEX_SIZE_ERR: if <code>index</code> is greater
than or equal
+ * to the number of objects in the list
*/
public short item(int index)
throws XSException;
diff --git a/src/org/apache/xerces/xs/StringList.java
b/src/org/apache/xerces/xs/StringList.java
index 933cd6e9f..e0c999cd3 100644
--- a/src/org/apache/xerces/xs/StringList.java
+++ b/src/org/apache/xerces/xs/StringList.java
@@ -20,34 +20,38 @@ package org.apache.xerces.xs;
import java.util.List;
/**
- * The <code>StringList</code> is an immutable ordered collection of
- * <code>GenericString</code>.
+ * The <code>StringList</code> is an immutable, ordered collection of
<code>GenericString</code>.
*/
public interface StringList extends List {
+
/**
- * The number of <code>GenericString</code>s in the list. The range of
- * valid child object indices is 0 to <code>length-1</code> inclusive.
+ * The number of <code>GenericString</code>s in the list. The range of
+ * valid child object indices is 0 to <code>length-1</code> inclusive.
+ *
+ * @return the number of <code>GenericString</code>s in the list
*/
public int getLength();
/**
- * Checks if the <code>GenericString</code> <code>item</code> is a member
- * of this list.
- * @param item <code>GenericString</code> whose presence in this list is
- * to be tested.
- * @return True if this list contains the <code>GenericString</code>
- * <code>item</code>.
+ * Checks if the <code>GenericString</code> <code>item</code> is a member
+ * of this list.
+ *
+ * @param item the <code>GenericString</code> whose presence in this list
is
+ * to be tested
+ * @return true if this list contains the <code>GenericString</code>
+ * <code>item</code>
*/
public boolean contains(String item);
/**
- * Returns the <code>index</code>th item in the collection or
+ * Returns the <code>index</code>th item in the collection or
* <code>null</code> if <code>index</code> is greater than or equal to
- * the number of objects in the list. The index starts at 0.
- * @param index index into the collection.
- * @return The <code>GenericString</code> at the <code>index</code>th
+ * the number of objects in the list. The index starts at 0.
+ *
+ * @param index the index into the collection
+ * @return the <code>GenericString</code> at the <code>index</code>th
* position in the <code>StringList</code>, or <code>null</code> if
- * the index specified is not valid.
+ * the index specified is not valid
*/
public String item(int index);
diff --git a/src/org/apache/xerces/xs/XSAnnotation.java
b/src/org/apache/xerces/xs/XSAnnotation.java
index e49d2e847..4704c4b64 100644
--- a/src/org/apache/xerces/xs/XSAnnotation.java
+++ b/src/org/apache/xerces/xs/XSAnnotation.java
@@ -36,24 +36,27 @@ public interface XSAnnotation extends XSObject {
public static final short W3C_DOM_DOCUMENT = 3;
/**
- * Write contents of the annotation to the specified object. If the
+ * Write contents of the annotation to the specified object. If the
* specified <code>target</code> is a DOM object, in-scope namespace
* declarations for <code>annotation</code> element are added as
* attribute nodes of the serialized <code>annotation</code>, otherwise
* the corresponding events for all in-scope namespace declarations are
- * sent via the specified document handler.
+ * sent via the specified document handler.
+ *
* @param target A target pointer to the annotation target object, i.e.
- * <code>org.w3c.dom.Document</code>, <code>org.w3c.dom.Element</code>
- * , <code>org.xml.sax.ContentHandler</code>.
- * @param targetType A target type.
- * @return True if the <code>target</code> is a recognized type and
- * supported by this implementation, otherwise false.
+ * <code>org.w3c.dom.Document</code>, <code>org.w3c.dom.Element</code>,
+ * <code>org.xml.sax.ContentHandler</code>
+ * @param targetType a target type
+ * @return true if the <code>target</code> is a recognized type and
+ * supported by this implementation, otherwise false
*/
public boolean writeAnnotation(Object target,
short targetType);
/**
* A text representation of the annotation.
+ *
+ * @return a text representation of the annotation
*/
public String getAnnotationString();
diff --git a/src/org/apache/xerces/xs/XSAttributeDeclaration.java
b/src/org/apache/xerces/xs/XSAttributeDeclaration.java
index 81bf8c393..ddbfa2db3 100644
--- a/src/org/apache/xerces/xs/XSAttributeDeclaration.java
+++ b/src/org/apache/xerces/xs/XSAttributeDeclaration.java
@@ -21,48 +21,63 @@ package org.apache.xerces.xs;
* The interface represents the Attribute Declaration schema component.
*/
public interface XSAttributeDeclaration extends XSObject {
+
/**
- * [type definition]: A simple type definition.
+ * [type definition]: A simple type definition.
+ *
+ * @return a simple type definition
*/
public XSSimpleTypeDefinition getTypeDefinition();
/**
* [scope]. One of <code>SCOPE_GLOBAL</code>, <code>SCOPE_LOCAL</code>, or
* <code>SCOPE_ABSENT</code>. If the scope is local, then the
- * <code>enclosingCTDefinition</code> is present.
+ * <code>enclosingCTDefinition</code> is present.
+ *
+ * @return one of <code>SCOPE_GLOBAL</code>, <code>SCOPE_LOCAL</code>, or
<code>SCOPE_ABSENT</code>
+ * @see XSConstants#SCOPE_GLOBAL
+ * @see XSConstants#SCOPE_LOCAL
+ * @see XSConstants#SCOPE_ABSENT
*/
public short getScope();
/**
- * The complex type definition for locally scoped declarations (see
- * <code>scope</code>), otherwise <code>null</code> if no such
- * definition exists.
+ * The complex type definition for locally scoped declarations (see
<code>scope</code>),
+ * otherwise <code>null</code> if no such definition exists.
+ *
+ * @return the complex type definition for locally scoped declarations
otherwise null
*/
public XSComplexTypeDefinition getEnclosingCTDefinition();
/**
- * Value constraint: one of <code>VC_NONE, VC_DEFAULT, VC_FIXED</code>.
+ * Value constraint: one of <code>VC_NONE, VC_DEFAULT, VC_FIXED</code>.
+ *
+ * @return one of <code>VC_NONE, VC_DEFAULT, VC_FIXED</code>
+ * @see XSConstants#VC_NONE
+ * @see XSConstants#VC_DEFAULT
+ * @see XSConstants#VC_FIXED
*/
public short getConstraintType();
/**
- * Value constraint: The constraint value with respect to the [type
- * definition], otherwise <code>null</code>.
- *
+ * Value constraint: The constraint value with respect to the [type
definition],
+ * otherwise <code>null</code>.
+ *
+ * @return the constraint value with respect to the type definition or null
* @deprecated Use getValueConstraintValue().getNormalizedValue() instead
*/
@Deprecated
public String getConstraintValue();
/**
- * Value Constraint: Binding specific actual constraint value or
- * <code>null</code> if the value is in error or there is no value
- * constraint.
- * @exception XSException
- * NOT_SUPPORTED_ERR: Raised if the implementation does not support this
- * method.
+ * Value Constraint: Binding specific actual constraint value or
<code>null</code>
+ * if the value is in error or there is no value constraint.
+ *
+ * @return the binding specific actual constraint value or null
+ * @exception XSException NOT_SUPPORTED_ERR: Raised if the implementation
+ * does not support this method.
*
- * @deprecated Use getValueConstraintValue().getActualValue() instead
+ * @deprecated Use getValueConstraintValue().getActualValue() instead
*/
@Deprecated
public Object getActualVC()
@@ -77,12 +92,13 @@ public interface XSAttributeDeclaration extends XSObject {
* method returns <code>LISTOFUNION_DT</code>. To query the actual
* constraint value of the list or list of union type definitions use
* <code>itemValueTypes</code>. If the <code>actualValue</code> is
- * <code>null</code>, this method returns <code>UNAVAILABLE_DT</code>.
- * @exception XSException
- * NOT_SUPPORTED_ERR: Raised if the implementation does not support this
- * method.
+ * <code>null</code>, this method returns <code>UNAVAILABLE_DT</code>.
+ *
+ * @return the actual constraint value built-in datatype
+ * @exception XSException NOT_SUPPORTED_ERR: Raised if the implementation
+ * does not support this method.
*
- * @deprecated Use getValueConstraintValue().getActualValueType() instead
+ * @deprecated Use getValueConstraintValue().getActualValueType() instead
*/
@Deprecated
public short getActualVCType()
@@ -96,12 +112,14 @@ public interface XSAttributeDeclaration extends XSObject {
* type is a union type definition, i.e. <code>LISTOFUNION_DT</code>,
* for each actual constraint value in the list the array contains the
* corresponding memberType kind. For examples, see
- * <code>ItemPSVI.itemValueTypes</code>.
- * @exception XSException
- * NOT_SUPPORTED_ERR: Raised if the implementation does not support this
- * method.
- *
- * @deprecated Use getValueConstraintValue().getListValueTypes() instead
+ * <code>ItemPSVI.itemValueTypes</code>.
+ *
+ * @return the types that are used with the list if
<code>actualValueType</code>
+ * is a <code>LIST_DT</code> or <code>LISTOFUNION_DT</code>
+ * @throws XSException NOT_SUPPORTED_ERR: Raised if the implementation
+ * does not support this method.
+ *
+ * @deprecated Use getValueConstraintValue().getListValueTypes() instead
*/
@Deprecated
public ShortList getItemValueTypes()
@@ -109,17 +127,23 @@ public interface XSAttributeDeclaration extends XSObject {
/**
* The actual value of the default or fixed value constraint.
+ *
+ * @return the actual value of the default or fixed value constraint
*/
public XSValue getValueConstraintValue();
/**
- * An annotation if it exists, otherwise <code>null</code>.
+ * An annotation if it exists, otherwise <code>null</code>.
* If not null then the first [annotation] from the sequence of
annotations.
+ *
+ * @return an annotation if it exists, otherwise null
*/
public XSAnnotation getAnnotation();
/**
- * A sequence of [annotations] or an empty <code>XSObjectList</code>.
+ * A sequence of [annotations] or an empty <code>XSObjectList</code>.
+ *
+ * @return a sequence of annotations or an empty <code>XSObjectList</code>
*/
public XSObjectList getAnnotations();
}
diff --git a/src/org/apache/xerces/xs/XSAttributeGroupDefinition.java
b/src/org/apache/xerces/xs/XSAttributeGroupDefinition.java
index 860526e18..f91913e02 100644
--- a/src/org/apache/xerces/xs/XSAttributeGroupDefinition.java
+++ b/src/org/apache/xerces/xs/XSAttributeGroupDefinition.java
@@ -21,25 +21,33 @@ package org.apache.xerces.xs;
* This interface represents the Attribute Group Definition schema component.
*/
public interface XSAttributeGroupDefinition extends XSObject {
+
/**
- * A set of [attribute uses] if it exists, otherwise an empty
- * <code>XSObjectList</code>.
+ * A set of [attribute uses] if it exists, otherwise an empty
<code>XSObjectList</code>.
+ *
+ * @return a list of attribute uses if it exists, otherwise an empty
<code>XSObjectList</code>
*/
public XSObjectList getAttributeUses();
/**
- * A [wildcard] if it exists, otherwise <code>null</code>.
+ * A [wildcard] if it exists, otherwise <code>null</code>.
+ *
+ * @return a wildcard if it exists, otherwise <code>null</code>
*/
public XSWildcard getAttributeWildcard();
/**
* An annotation if it exists, otherwise <code>null</code>. If not null
* then the first [annotation] from the sequence of annotations.
+ *
+ * @return an annotation if it exists, otherwise <code>null</code>
*/
public XSAnnotation getAnnotation();
/**
* A sequence of [annotations] or an empty <code>XSObjectList</code>.
+ *
+ * @return a sequence of annotations or an empty <code>XSObjectList</code>
*/
public XSObjectList getAnnotations();
}
diff --git a/src/org/apache/xerces/xs/XSAttributeUse.java
b/src/org/apache/xerces/xs/XSAttributeUse.java
index 207f1dd16..0341ff4ca 100644
--- a/src/org/apache/xerces/xs/XSAttributeUse.java
+++ b/src/org/apache/xerces/xs/XSAttributeUse.java
@@ -21,27 +21,35 @@ package org.apache.xerces.xs;
* This interface represents the Attribute Use schema component.
*/
public interface XSAttributeUse extends XSObject {
+
/**
* [required]: determines whether this use of an attribute declaration
* requires an appropriate attribute information item to be present, or
- * merely allows it.
+ * merely allows it.
+ *
+ * @return true if an attribute information item should be present
*/
public boolean getRequired();
/**
* [attribute declaration]: provides the attribute declaration itself,
- * which will in turn determine the simple type definition used.
+ * which will in turn determine the simple type definition used.
+ *
+ * @return the attribute declaration itself
*/
public XSAttributeDeclaration getAttrDeclaration();
/**
* Value Constraint: one of default, fixed, or none.
+ *
+ * @return one of default, fixed, or none
*/
public short getConstraintType();
/**
* Value Constraint: The constraint value, otherwise <code>null</code>.
- *
+ *
+ * @return the constraint value, otherwise null
* @deprecated Use getValueConstraintValue().getNormalizedValue() instead
*/
@Deprecated
@@ -50,7 +58,9 @@ public interface XSAttributeUse extends XSObject {
/**
* Value Constraint: Binding specific actual constraint value or
* <code>null</code> if the value is in error or there is no value
- * constraint.
+ * constraint.
+ *
+ * @return the actual constraint value or null
* @exception XSException
* NOT_SUPPORTED_ERR: Raised if the implementation does not support this
* method.
@@ -70,10 +80,11 @@ public interface XSAttributeUse extends XSObject {
* method returns <code>LISTOFUNION_DT</code>. To query the actual
* constraint value of the list or list of union type definitions use
* <code>itemValueTypes</code>. If the <code>actualNormalizedValue</code>
- * is <code>null</code>, this method returns <code>UNAVAILABLE_DT</code>.
- * @exception XSException
- * NOT_SUPPORTED_ERR: Raised if the implementation does not support this
- * method.
+ * is <code>null</code>, this method returns <code>UNAVAILABLE_DT</code>.
+ *
+ * @return the datatype of the actual constraint value
+ * @exception XSException NOT_SUPPORTED_ERR: Raised if the implementation
+ * does not support this method
*
* @deprecated Use getValueConstraintValue().getActualValueType() instead
*/
@@ -88,11 +99,11 @@ public interface XSAttributeUse extends XSObject {
* actual constraint value represents a list type definition whose item
* type is a union type definition, i.e. <code>LISTOFUNION_DT</code>,
* for each actual constraint value in the list the array contains the
- * corresponding memberType kind. For examples, see
- * <code>ItemPSVI.itemValueTypes</code>.
- * @exception XSException
- * NOT_SUPPORTED_ERR: Raised if the implementation does not support this
- * method.
+ * corresponding memberType kind. For examples, see {@link
ItemPSVI#getItemValueTypes()}.
+ *
+ * @return the types for items within the list if the actual constraint
value represents a list
+ * @exception XSException NOT_SUPPORTED_ERR: Raised if the implementation
+ * does not support this method
*
* @deprecated Use getValueConstraintValue().getListValueTypes() instead
*/
@@ -102,11 +113,15 @@ public interface XSAttributeUse extends XSObject {
/**
* The actual value of the default or fixed value constraint.
+ *
+ * @return the actual value of the default or fixed value constraint
*/
public XSValue getValueConstraintValue();
/**
* A sequence of [annotations] or an empty <code>XSObjectList</code>.
+ *
+ * @return a sequence of annotations or an empty <code>XSObjectList</code>
*/
public XSObjectList getAnnotations();
}
diff --git a/src/org/apache/xerces/xs/XSComplexTypeDefinition.java
b/src/org/apache/xerces/xs/XSComplexTypeDefinition.java
index 00bc875dc..c2c21e3dd 100644
--- a/src/org/apache/xerces/xs/XSComplexTypeDefinition.java
+++ b/src/org/apache/xerces/xs/XSComplexTypeDefinition.java
@@ -47,45 +47,64 @@ public interface XSComplexTypeDefinition extends
XSTypeDefinition {
/**
* [derivation method]: either <code>DERIVATION_EXTENSION</code>,
* <code>DERIVATION_RESTRICTION</code>, or <code>DERIVATION_NONE</code>
- * (see <code>XSConstants</code>).
+ * (see <code>XSConstants</code>).
+ *
+ * @return the derivation method as a short
+ * @see XSConstants#DERIVATION_EXTENSION
+ * @see XSConstants#DERIVATION_RESTRICTION
+ * @see XSConstants#DERIVATION_NONE
*/
public short getDerivationMethod();
/**
* [abstract]: a boolean. Complex types for which <code>abstract</code> is
* true must not be used as the type definition for the validation of
- * element information items.
+ * element information items.
+ *
+ * @return true if the element is abstract
*/
public boolean getAbstract();
/**
- * A set of attribute uses if it exists, otherwise an empty
- * <code>XSObjectList</code>.
+ * A set of attribute uses if it exists, otherwise an empty
<code>XSObjectList</code>.
+ *
+ * @return a list of attribute uses if it exists, otherwise an empty
<code>XSObjectList</code>
*/
public XSObjectList getAttributeUses();
/**
- * An attribute wildcard if it exists, otherwise <code>null</code>.
+ * An attribute wildcard if it exists, otherwise <code>null</code>.
+ *
+ * @return an attribute wildcard if it exists, otherwise null
*/
public XSWildcard getAttributeWildcard();
/**
- * [content type]: one of empty (<code>CONTENTTYPE_EMPTY</code>), a simple
- * type definition (<code>CONTENTTYPE_SIMPLE</code>), mixed (
- * <code>CONTENTTYPE_MIXED</code>), or element-only (
- * <code>CONTENTTYPE_ELEMENT</code>).
+ * [content type]: one of empty ({@link #CONTENTTYPE_EMPTY}),
+ * a simple type definition ({@link #CONTENTTYPE_SIMPLE}),
+ * mixed ({@link #CONTENTTYPE_MIXED}),
+ * or element-only ({@link #CONTENTTYPE_ELEMENT}).
+ *
+ * @return the content type as a short
+ *
+ * @see #CONTENTTYPE_EMPTY
+ * @see #CONTENTTYPE_SIMPLE
+ * @see #CONTENTTYPE_ELEMENT
+ * @see #CONTENTTYPE_MIXED
*/
public short getContentType();
/**
- * A simple type definition corresponding to a simple content model,
- * otherwise <code>null</code>.
+ * A simple type definition corresponding to a simple content model,
otherwise <code>null</code>.
+ *
+ * @return a simple type definition corresponding to a simple content
model, otherwise null
*/
public XSSimpleTypeDefinition getSimpleType();
/**
- * A particle for a mixed or element-only content model, otherwise
- * <code>null</code>.
+ * A particle for a mixed or element-only content model, otherwise
<code>null</code>.
+ *
+ * @return a particle for a mixed or element-only content model, otherwise
null
*/
public XSParticle getParticle();
@@ -98,14 +117,17 @@ public interface XSComplexTypeDefinition extends
XSTypeDefinition {
public boolean isProhibitedSubstitution(short restriction);
/**
- * [prohibited substitutions]: A subset of {extension, restriction} or
- * <code>DERIVATION_NONE</code> represented as a bit flag (see
- * <code>XSConstants</code>).
+ * [prohibited substitutions]: A subset of {extension, restriction} or
+ * <code>DERIVATION_NONE</code> represented as a bit flag (see
<code>XSConstants</code>).
+ *
+ * @return a bit flag of {extension, restriction} or {@link
XSConstants#DERIVATION_NONE}
*/
public short getProhibitedSubstitutions();
/**
* A sequence of [annotations] or an empty <code>XSObjectList</code>.
+ *
+ * @return a sequence of annotations or an empty <code>XSObjectList</code>
*/
public XSObjectList getAnnotations();
diff --git a/src/org/apache/xerces/xs/XSElementDeclaration.java
b/src/org/apache/xerces/xs/XSElementDeclaration.java
index a13a8aad6..b78e1d5a7 100644
--- a/src/org/apache/xerces/xs/XSElementDeclaration.java
+++ b/src/org/apache/xerces/xs/XSElementDeclaration.java
@@ -22,48 +22,62 @@ package org.apache.xerces.xs;
*/
public interface XSElementDeclaration extends XSTerm {
/**
- * [type definition]: either a simple type definition or a complex type
- * definition.
+ * [type definition]: either a simple type definition or a complex type
definition.
+ *
+ * @return the type definition, either simple or complex
*/
public XSTypeDefinition getTypeDefinition();
/**
- * [scope]. One of <code>SCOPE_GLOBAL</code>, <code>SCOPE_LOCAL</code>, or
- * <code>SCOPE_ABSENT</code>. If the scope is local, then the
- * <code>enclosingCTDefinition</code> is present.
+ * [scope]. One of <code>SCOPE_GLOBAL</code>, <code>SCOPE_LOCAL</code>, or
+ * <code>SCOPE_ABSENT</code>. If the scope is local, then the
+ * <code>enclosingCTDefinition</code> is present.
+ *
+ * @return a short value as defined by <code>SCOPE_GLOBAL</code>,
<code>SCOPE_LOCAL</code>, or <code>SCOPE_ABSENT</code>
+ * @see XSConstants#SCOPE_ABSENT
+ * @see XSConstants#SCOPE_GLOBAL
+ * @see XSConstants#SCOPE_LOCAL
*/
public short getScope();
/**
- * The complex type definition for locally scoped declarations (see
- * <code>scope</code>), otherwise <code>null</code> if no such
- * definition exists.
+ * The complex type definition for locally scoped declarations (see {@link
#getScope()}),
+ * otherwise <code>null</code> if no such definition exists.
+ *
+ * @return the enclosing complex type definition or null if no such
definition exists
*/
public XSComplexTypeDefinition getEnclosingCTDefinition();
/**
- * [Value constraint]: one of <code>VC_NONE, VC_DEFAULT, VC_FIXED</code>.
+ * [Value constraint]: one of <code>VC_NONE, VC_DEFAULT, VC_FIXED</code>.
+ *
+ * @return the constraint type
+ * @see XSConstants#VC_NONE
+ * @see XSConstants#VC_DEFAULT
+ * @see XSConstants#VC_FIXED
*/
public short getConstraintType();
/**
* [Value constraint]: the constraint value with respect to the [type
- * definition], otherwise <code>null</code>.
- *
+ * definition], otherwise null.
+ *
+ * @return the constraint value or null
* @deprecated Use getValueConstraintValue().getNormalizedValue() instead
*/
@Deprecated
public String getConstraintValue();
/**
- * Value Constraint: Binding specific actual constraint value or
- * <code>null</code> if the value is in error or there is no value
- * constraint.
- * @exception XSException
- * NOT_SUPPORTED_ERR: Raised if the implementation does not support this
- * method.
+ * Value Constraint: Binding specific actual constraint value or null
+ * if the value is in error or there is no value constraint.
+ *
+ * @return constraint value or null
+ * @throws XSException NOT_SUPPORTED_ERR: Raised if the implementation
+ * does not support this method
*
* @deprecated Use getValueConstraintValue().getActualValue() instead
+ * @see #getValueConstraintValue()
*/
@Deprecated
public Object getActualVC()
@@ -79,11 +93,18 @@ public interface XSElementDeclaration extends XSTerm {
* constraint value of the list or list of union type definitions use
* <code>itemValueTypes</code>. If the <code>actualNormalizedValue</code>
* is <code>null</code>, this method returns <code>UNAVAILABLE_DT</code>.
- * @exception XSException
- * NOT_SUPPORTED_ERR: Raised if the implementation does not support this
- * method.
+ *
+ * @return one of the specified {@link XSConstants}
+ * @throws XSException NOT_SUPPORTED_ERR: Raised if the implementation does
+ * not support this method.
*
* @deprecated Use getValueConstraintValue().getActualValueType() instead
+ * @see XSConstants#STRING_DT
+ * @see XSConstants#SHORT_DT
+ * @see XSConstants#LIST_DT
+ * @see XSConstants#LISTOFUNION_DT
+ * @see XSConstants#UNAVAILABLE_DT
+ * @see #getValueConstraintValue()
*/
@Deprecated
public short getActualVCType()
@@ -96,11 +117,12 @@ public interface XSElementDeclaration extends XSTerm {
* actual constraint value represents a list type definition whose item
* type is a union type definition, i.e. <code>LISTOFUNION_DT</code>,
* for each actual constraint value in the list the array contains the
- * corresponding memberType kind. For examples, see
- * <code>ItemPSVI.itemValueTypes</code>.
- * @exception XSException
- * NOT_SUPPORTED_ERR: Raised if the implementation does not support this
- * method.
+ * corresponding memberType kind. For examples, see {@link
ItemPSVI#getItemValueTypes()}.
+ *
+ * @return the types that are used with the list if
<code>actualValueType</code>
+ * is a <code>LIST_DT</code> or <code>LISTOFUNION_DT</code>
+ * @throws XSException NOT_SUPPORTED_ERR: Raised if the implementation does
+ * not support this method
*
* @deprecated Use getValueConstraintValue().getListValueTypes() instead
*/
@@ -110,28 +132,37 @@ public interface XSElementDeclaration extends XSTerm {
/**
* The actual value of the default or fixed value constraint.
+ *
+ * @return the actual value of the default or fixed value constraint
*/
public XSValue getValueConstraintValue();
/**
- * If nillable is true, then an element may also be valid if it carries
+ * If nillable is true, then an element may also be valid if it carries
* the namespace qualified attribute with local name <code>nil</code>
* from namespace <code>http://www.w3.org/2001/XMLSchema-instance</code>
* and value <code>true</code> (xsi:nil) even if it has no text or
* element content despite a <code>content type</code> which would
- * otherwise require content.
+ * otherwise require content.
+ *
+ * @return true if the element could be <code>nil</code>
*/
public boolean getNillable();
/**
* identity-constraint definitions: a set of constraint definitions if it
- * exists, otherwise an empty <code>XSNamedMap</code>.
+ * exists, otherwise an empty <code>XSNamedMap</code>.
+ *
+ * @return a collection of constraint definitions if it exists, otherwise
an
+ * empty <code>XSNamedMap</code>
*/
public XSNamedMap getIdentityConstraints();
/**
* [substitution group affiliation]: a top-level element definition if it
- * exists, otherwise <code>null</code>.
+ * exists, otherwise <code>null</code>.
+ *
+ * @return a top-level element definition if it exists, otherwise null
*/
public XSElementDeclaration getSubstitutionGroupAffiliation();
@@ -143,14 +174,22 @@ public interface XSElementDeclaration extends XSTerm {
* <code>DERIVATION_EXTENSION, DERIVATION_RESTRICTION</code> or
* <code>DERIVATION_NONE</code>. Represents final set for the element
* @return true if <code>exclusion</code> is a part of the substitution
group exclusion subset
+ * @see XSConstants#DERIVATION_EXTENSION
+ * @see XSConstants#DERIVATION_RESTRICTION
+ * @see XSConstants#DERIVATION_NONE
*/
public boolean isSubstitutionGroupExclusion(short exclusion);
/**
- * [substitution group exclusions]: the returned value is a bit
+ * [substitution group exclusions]: the returned value is a bit
* combination of the subset of {
* <code>DERIVATION_EXTENSION, DERIVATION_RESTRICTION</code>} or
- * <code>DERIVATION_NONE</code>.
+ * <code>DERIVATION_NONE</code>.
+ *
+ * @return the substitution group exclusions
+ * @see XSConstants#DERIVATION_EXTENSION
+ * @see XSConstants#DERIVATION_RESTRICTION
+ * @see XSConstants#DERIVATION_NONE
*/
public short getSubstitutionGroupExclusions();
@@ -166,27 +205,35 @@ public interface XSElementDeclaration extends XSTerm {
public boolean isDisallowedSubstitution(short disallowed);
/**
- * [disallowed substitutions]: the returned value is a bit combination of
+ * [disallowed substitutions]: the returned value is a bit-combination of
* the subset of {
* <code>DERIVATION_SUBSTITUTION, DERIVATION_EXTENSION,
DERIVATION_RESTRICTION</code>
* } corresponding to substitutions disallowed by this
- * <code>XSElementDeclaration</code> or <code>DERIVATION_NONE</code>.
+ * <code>XSElementDeclaration</code> or <code>DERIVATION_NONE</code>.
+ *
+ * @return the disallowed substitutions
*/
public short getDisallowedSubstitutions();
/**
- * {abstract} A boolean.
+ * {abstract} A boolean.
+ *
+ * @return true if the element is abstract
*/
public boolean getAbstract();
/**
* An annotation if it exists, otherwise <code>null</code>. If not null
* then the first [annotation] from the sequence of annotations.
+ *
+ * @return an annotation if it exists, otherwise null
*/
public XSAnnotation getAnnotation();
/**
* A sequence of [annotations] or an empty <code>XSObjectList</code>.
+ *
+ * @return a sequence of annotations or an empty <code>XSObjectList</code>
*/
public XSObjectList getAnnotations();
}
diff --git a/src/org/apache/xerces/xs/XSTypeDefinition.java
b/src/org/apache/xerces/xs/XSTypeDefinition.java
index 5c021a0fb..4c0181439 100644
--- a/src/org/apache/xerces/xs/XSTypeDefinition.java
+++ b/src/org/apache/xerces/xs/XSTypeDefinition.java
@@ -29,71 +29,84 @@ public interface XSTypeDefinition extends XSObject {
* The object describes a simple type.
*/
public static final short SIMPLE_TYPE = 16;
+
/**
* Return whether this type definition is a simple type or complex type.
+ *
+ * @return either <code>SIMPLE_TYPE</code> or <code>COMPLEX_TYPE</code>
+ * @see #SIMPLE_TYPE
+ * @see #COMPLEX_TYPE
*/
public short getTypeCategory();
/**
- * {base type definition}: either a simple type definition or a complex
- * type definition.
+ * {base type definition}: either a simple type definition or a complex
type definition.
+ *
+ * @return the base type definition
*/
public XSTypeDefinition getBaseType();
/**
- * {final}. For a complex type definition it is a subset of {extension,
- * restriction}. For a simple type definition it is a subset of
- * {extension, list, restriction, union}.
+ * {final}. For a complex type definition it is a subset of {extension,
restriction}.
+ * For a simple type definition it is a subset of {extension, list,
restriction, union}.
+ *
* @param restriction Extension, restriction, list, union constants
- * (defined in <code>XSConstants</code>).
- * @return True if <code>restriction</code> is in the final set,
- * otherwise false.
+ * (defined in <code>XSConstants</code>)
+ * @return true if <code>restriction</code> is in the final set, otherwise
false
+ *
+ * @see XSConstants
*/
public boolean isFinal(short restriction);
/**
- * For complex types the returned value is a bit combination of the subset
+ * For complex types the returned value is a bit-combination of the subset
* of {<code>DERIVATION_EXTENSION, DERIVATION_RESTRICTION</code>}
* corresponding to <code>final</code> set of this type or
* <code>DERIVATION_NONE</code>. For simple types the returned value is
- * a bit combination of the subset of {
+ * a bit-combination of the subset of {
* <code>DERIVATION_RESTRICTION, DERIVATION_EXTENSION, DERIVATION_UNION,
DERIVATION_LIST</code>
* } corresponding to <code>final</code> set of this type or
- * <code>DERIVATION_NONE</code>.
+ * <code>DERIVATION_NONE</code>.
+ *
+ * @return a bit-combination representing a subset of
+ * {<code>DERIVATION_EXTENSION, DERIVATION_RESTRICTION</code>}, of a
subset of
+ * {<code>DERIVATION_RESTRICTION, DERIVATION_EXTENSION, DERIVATION_UNION,
DERIVATION_LIST</code>}
+ * or <code>DERIVATION_NONE</code>
*/
public short getFinal();
/**
- * Convenience attribute. A boolean that specifies if the type definition
- * is anonymous.
+ * Convenience attribute. A boolean that specifies if the type definition
is anonymous.
+ *
+ * @return true if the type definition is anonymous
*/
public boolean getAnonymous();
/**
* Convenience method which checks if this type is derived from the given
- * <code>ancestorType</code>.
- * @param ancestorType An ancestor type definition.
- * @param derivationMethod A bit combination representing a subset of {
+ * <code>ancestorType</code>.
+ *
+ * @param ancestorType An ancestor type definition
+ * @param derivationMethod A bit-combination representing a subset of {
* <code>DERIVATION_RESTRICTION, DERIVATION_EXTENSION, DERIVATION_UNION,
DERIVATION_LIST</code>
- * }.
- * @return True if this type is derived from <code>ancestorType</code>
+ * }
+ * @return true if this type is derived from <code>ancestorType</code>
* using only derivation methods from the <code>derivationMethod</code>
- * .
*/
public boolean derivedFromType(XSTypeDefinition ancestorType,
short derivationMethod);
/**
* Convenience method which checks if this type is derived from the given
- * ancestor type.
- * @param namespace An ancestor type namespace.
- * @param name An ancestor type name.
- * @param derivationMethod A bit combination representing a subset of {
+ * ancestor type.
+ *
+ * @param namespace an ancestor type namespace
+ * @param name an ancestor type name
+ * @param derivationMethod a bit-combination representing a subset of {
* <code>DERIVATION_RESTRICTION, DERIVATION_EXTENSION, DERIVATION_UNION,
DERIVATION_LIST</code>
- * }.
- * @return True if this type is derived from <code>ancestorType</code>
+ * }
+ * @return true if this type is derived from <code>ancestorType</code>
* using only derivation methods from the <code>derivationMethod</code>
- * .
*/
public boolean derivedFrom(String namespace,
String name,
diff --git a/src/org/apache/xerces/xs/datatypes/ByteList.java
b/src/org/apache/xerces/xs/datatypes/ByteList.java
index 3e5e46186..441324140 100644
--- a/src/org/apache/xerces/xs/datatypes/ByteList.java
+++ b/src/org/apache/xerces/xs/datatypes/ByteList.java
@@ -21,8 +21,7 @@ import java.util.List;
import org.apache.xerces.xs.XSException;
/**
- * <p>The <code>ByteList</code> is an immutable ordered collection of
- * <code>byte</code>.</p>
+ * The <code>ByteList</code> is an immutable, ordered collection of
<code>byte</code>.
*
* @author Ankit Pasricha, IBM
*
@@ -32,34 +31,35 @@ public interface ByteList extends List {
/**
* The number of <code>byte</code>s in the list. The range of
- * valid child object indices is 0 to <code>length-1</code> inclusive.
+ * valid child object indices is 0 to <code>length-1</code> inclusive.
+ *
+ * @return the number of <code>byte</code>s in the list
*/
public int getLength();
/**
- * Checks if the <code>byte</code> <code>item</code> is a
- * member of this list.
- * @param item <code>byte</code> whose presence in this list
- * is to be tested.
- * @return True if this list contains the <code>byte</code>
- * <code>item</code>.
+ * Checks if the <code>byte</code> <code>item</code> is a member of this
list.
+ *
+ * @param item <code>byte</code> whose presence in this list is to be
tested
+ * @return true if this list contains the <code>byte</code>
<code>item</code>
*/
public boolean contains(byte item);
/**
* Returns the <code>index</code>th item in the collection. The index
- * starts at 0.
- * @param index index into the collection.
- * @return The <code>byte</code> at the <code>index</code>th
- * position in the <code>ByteList</code>.
- * @exception XSException
- * INDEX_SIZE_ERR: if <code>index</code> is greater than or equal to the
- * number of objects in the list or less than zero.
+ * starts at 0.
+ *
+ * @param index the index into the collection
+ * @return the <code>byte</code> at the <code>index</code>th position in
the <code>ByteList</code>
+ * @throws XSException INDEX_SIZE_ERR: if <code>index</code> is greater
than or
+ * equal to the number of objects in the list or less than zero
*/
public byte item(int index) throws XSException;
/**
* Construct and return a byte array for bytes contained in this list.
+ *
+ * @return a byte array for bytes contained in this list
*/
public byte[] toByteArray();
}
diff --git a/src/org/apache/xerces/xs/datatypes/ObjectList.java
b/src/org/apache/xerces/xs/datatypes/ObjectList.java
index dfc40041b..6caec4a35 100644
--- a/src/org/apache/xerces/xs/datatypes/ObjectList.java
+++ b/src/org/apache/xerces/xs/datatypes/ObjectList.java
@@ -19,9 +19,8 @@ package org.apache.xerces.xs.datatypes;
import java.util.List;
/**
- * <p>The <code>ObjectList</code> is an immutable ordered collection of
- * <code>Object</code>.</p>
- *
+ * The <code>ObjectList</code> is an immutable, ordered collection of
<code>Object</code>.
+ *
* @author Ankit Pasricha, IBM
*
* @version $Id$
@@ -30,26 +29,27 @@ public interface ObjectList extends List {
/**
* The number of <code>Object</code>s in the list. The range of
- * valid child object indices is 0 to <code>length-1</code> inclusive.
+ * valid child object indices is 0 to <code>length-1</code> inclusive.
+ *
+ * @return the number of <code>Object</code>s in the list
*/
public int getLength();
/**
- * Checks if the <code>Object</code> <code>item</code> is a
- * member of this list.
- * @param item <code>Object</code> whose presence in this list
- * is to be tested.
- * @return True if this list contains the <code>Object</code>
- * <code>item</code>.
+ * Checks if the <code>Object</code> <code>item</code> is a member of this
list.
+ *
+ * @param item the <code>Object</code> whose presence in this list is to
be tested
+ * @return true if this list contains the <code>Object</code>
<code>item</code>
*/
public boolean contains(Object item);
/**
* Returns the <code>index</code>th item in the collection or
* <code>null</code> if <code>index</code> is greater than or equal to
- * the number of objects in the list. The index starts at 0.
- * @param index index into the collection.
- * @return The <code>Object</code> at the <code>index</code>th
+ * the number of objects in the list. The index starts at 0.
+ *
+ * @param index the index into the collection
+ * @return the <code>Object</code> at the <code>index</code>th
* position in the <code>ObjectList</code>, or <code>null</code> if
* the index specified is not valid - greater than or equal to the
* number of items in the list or less than zero.
diff --git a/src/org/apache/xerces/xs/datatypes/XSDateTime.java
b/src/org/apache/xerces/xs/datatypes/XSDateTime.java
index 6e0a07105..147fbf1ce 100644
--- a/src/org/apache/xerces/xs/datatypes/XSDateTime.java
+++ b/src/org/apache/xerces/xs/datatypes/XSDateTime.java
@@ -205,36 +205,56 @@ import javax.xml.datatype.XMLGregorianCalendar;
public interface XSDateTime {
/**
+ * Returns the years for this <code>xs:dateTime</code> or
<code>xs:date</code> (YYYY).
+ * <p>
+ * Note that year may be a negative value. This getter is only used for
+ * <code>xs:dateTime</code> and <code>xs:date</code>
+ * </p>
+ *
* @return years - can be negative for date-time related types;
- *
*/
public int getYears();
/**
+ * Returns the months for this <code>xs:dateTime</code>,
<code>xs:date</code>, or <code>xs:duration</code> (MM).
+ * <p>
+ * This getter is only used for <code>xs:dateTime</code>,
<code>xs:date</code>,
+ * and <code>xs:duration</code> types.
+ * </p>
+ *
* @return months - can be negative only for duration types;
* For duration types, it returns years*12 + months
*/
public int getMonths();
/**
+ * Returns the days for this <code>xs:dateTime</code> or
<code>xs:date</code>(DD).
+ * This getter is only used for <code>xs:dateTime</code> and
<code>xs:date</code> types.
+ *
* @return days - cannot be negative;
- *
*/
public int getDays();
/**
+ * Returns the hours for this <code>xs:dateTime</code> (hh).
+ *
* @return hours - cannot be negative;
- *
*/
public int getHours();
/**
+ * Returns the minutes for this <code>xs:dateTime</code> (mm).
+ *
* @return minutes - cannot be negative;
- *
*/
public int getMinutes();
/**
+ * Returns the seconds for this <code>xs:dateTime</code> (ss).
+ * <p>
+ * Note that <code>xs:duration</code> can have negative values for seconds.
+ * </p>
+ *
* @return seconds - can be negative only for durations;
* For duration types, it returns days*24*3600 +
hours*3600
* + minutes*60 + seconds
@@ -242,20 +262,23 @@ public interface XSDateTime {
public double getSeconds();
/**
+ * Returns true when timezone is specified in the original lexical value.
+ *
* @return boolean (true when timezone is specified in the original
lexical value)
- *
*/
public boolean hasTimeZone();
/**
- * @return timezone hours (for GMT-xx:xx this will be negative),
- *
+ * Returns timezone hours.
+ *
+ * @return timezone hours (for GMT-xx:xx this will be negative)
*/
public int getTimeZoneHours();
/**
- * @return timezone minutes (for GMT-xx:xx this will be negative),
- *
+ * Returns timezone minutes.
+ *
+ * @return timezone minutes (for GMT-xx:xx this will be negative)
*/
public int getTimeZoneMinutes();
@@ -266,24 +289,28 @@ public interface XSDateTime {
/**
* @return a new date-time related object with normalized values
- * (has no effect on objects already
- * normalized)
+ * (has no effect on objects already normalized)
*/
public XSDateTime normalize();
/**
+ * Returns whether a date-time related object is normalized or not.
+ * This is only useful for <code>xs:dateTime</code> that have timezone
+ *
* @return whether a date-time related object is normalized or not
* (value is not useful for types where timezone is not specified)
*/
public boolean isNormalized();
-
+
/**
* @return an un-normalized XMLGregorianCalendar (if applicable otherwise
null)
*/
public XMLGregorianCalendar getXMLGregorianCalendar();
-
+
/**
- * @return a Duration (if applicable otherwise null)
+ * Returns the duration if the datatype is a <code>xs:duration</code>
otherwise null.
+ *
+ * @return a Duration (only if the datatype is a <code>xs:duration</code>
otherwise null)
*/
public Duration getDuration();
}
diff --git a/src/org/apache/xerces/xs/datatypes/XSDecimal.java
b/src/org/apache/xerces/xs/datatypes/XSDecimal.java
index fccee8cc8..bb356f9ac 100644
--- a/src/org/apache/xerces/xs/datatypes/XSDecimal.java
+++ b/src/org/apache/xerces/xs/datatypes/XSDecimal.java
@@ -29,35 +29,47 @@ import java.math.BigInteger;
public interface XSDecimal {
/**
+ * Returns the <code>BigDecimal</code> representation of this object.
+ *
* @return the <code>BigDecimal</code> representation of this object
*/
public BigDecimal getBigDecimal();
/**
+ * Returns the <code>BigInteger</code> representation of this object.
+ *
* @return the <code>BigInteger</code> representation of this object
- * @exception NumberFormatException if the value cannot be represented as
a <code>BigInteger</code>
+ * @throws NumberFormatException if the value cannot be represented as a
<code>BigInteger</code>
*/
public BigInteger getBigInteger() throws NumberFormatException;
/**
+ * Returns the long value representation of this object.
+ *
* @return the long value representation of this object
* @exception NumberFormatException if the value cannot be represented as
a <code>long</code>
*/
public long getLong() throws NumberFormatException;
/**
+ * Returns the int value representation of this object.
+ *
* @return the int value representation of this object
* @exception NumberFormatException if the value cannot be represented as
a <code>int</code>
*/
public int getInt() throws NumberFormatException;
/**
+ * Returns the short value representation of this object.
+ *
* @return the short value representation of this object
* @exception NumberFormatException if the value cannot be represented as
a <code>short</code>
*/
public short getShort() throws NumberFormatException;
/**
+ * Returns the byte value representation of this object.
+ *
* @return the byte value representation of this object
* @exception NumberFormatException if the value cannot be represented as
a <code>byte</code>
*/
diff --git a/src/org/apache/xerces/xs/datatypes/XSDouble.java
b/src/org/apache/xerces/xs/datatypes/XSDouble.java
index 752aee55f..ee9aeef55 100644
--- a/src/org/apache/xerces/xs/datatypes/XSDouble.java
+++ b/src/org/apache/xerces/xs/datatypes/XSDouble.java
@@ -17,7 +17,7 @@
package org.apache.xerces.xs.datatypes;
/**
- * <p>Interface to expose the value of the 'double' datatype.</p>
+ * Interface to expose the value of the 'double' datatype.
*
* @author Ankit Pasricha, IBM
*
@@ -26,6 +26,8 @@ package org.apache.xerces.xs.datatypes;
public interface XSDouble {
/**
+ * Returns a double value.
+ *
* @return a double value
*/
public double getValue();
diff --git a/src/org/apache/xerces/xs/datatypes/XSFloat.java
b/src/org/apache/xerces/xs/datatypes/XSFloat.java
index 7715dbd17..e99e900a0 100644
--- a/src/org/apache/xerces/xs/datatypes/XSFloat.java
+++ b/src/org/apache/xerces/xs/datatypes/XSFloat.java
@@ -17,7 +17,7 @@
package org.apache.xerces.xs.datatypes;
/**
- * <p>Interface to expose value of the float datatype.</p>
+ * Interface to expose value of the float datatype.
*
* @author Ankit Pasricha, IBM
*
@@ -26,6 +26,8 @@ package org.apache.xerces.xs.datatypes;
public interface XSFloat {
/**
+ * Returns a float value.
+ *
* @return a float value
*/
public float getValue();
diff --git a/src/org/apache/xerces/xs/datatypes/XSQName.java
b/src/org/apache/xerces/xs/datatypes/XSQName.java
index b40a2fa89..68bbcc4d1 100644
--- a/src/org/apache/xerces/xs/datatypes/XSQName.java
+++ b/src/org/apache/xerces/xs/datatypes/XSQName.java
@@ -25,11 +25,15 @@ package org.apache.xerces.xs.datatypes;
public interface XSQName {
/**
+ * Returns org.apache.xerces.xni.QName class instance.
+ *
* @return org.apache.xerces.xni.QName class instance
*/
public org.apache.xerces.xni.QName getXNIQName();
/**
+ * Returns org.apache.xerces.xni.QName class instance.
+ *
* @return javax.xml.namespace.QName class instance
*/
public javax.xml.namespace.QName getJAXPQName();
diff --git a/src/org/apache/xml/serialize/SerializerFactory.java
b/src/org/apache/xml/serialize/SerializerFactory.java
index 82ced640d..540928c9f 100644
--- a/src/org/apache/xml/serialize/SerializerFactory.java
+++ b/src/org/apache/xml/serialize/SerializerFactory.java
@@ -87,8 +87,16 @@ public abstract class SerializerFactory {
/**
- * Register a serializer factory, keyed by the given
- * method string.
+ * Register a serializer factory, keyed by the given method string.
+ * <p>Xerces registers default serializer factories for</p>
+ * <ul>
+ * <li>{@link Method#XML}</li>
+ * <li>{@link Method#HTML}</li>
+ * <li>{@link Method#XHTML}</li>
+ * <li>{@link Method#TEXT}</li>
+ * </ul>
+ *
+ * @param factory the serializer factory to be registered
*/
public static void registerSerializerFactory( SerializerFactory factory )
{
@@ -102,8 +110,18 @@ public abstract class SerializerFactory {
/**
- * Register a serializer factory, keyed by the given
- * method string.
+ * Retrieve a serializer factory, keyed by the given method string.
+ * <p>Xerces registers default serializer factories for</p>
+ * <ul>
+ * <li>{@link Method#XML}</li>
+ * <li>{@link Method#HTML}</li>
+ * <li>{@link Method#XHTML}</li>
+ * <li>{@link Method#TEXT}</li>
+ * </ul>
+ *
+ * @param method the method string to retrieve the SerializerFactory by
+ * @return the serializer factory registered with the given method string
+ * @see Method
*/
public static SerializerFactory getSerializerFactory( String method )
{
@@ -117,6 +135,8 @@ public abstract class SerializerFactory {
* a properties file by knowing only the class name. This method is
* protected, it is only required by this class but must be implemented
* in derived classes.
+ *
+ * @return the method supported by this factory
*/
protected abstract String getSupportedMethod();
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
