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 ac1127130 [XERCESJ-1781] fix more Javadoc (#64)
ac1127130 is described below
commit ac1127130ef7267cb552249383da89f790db3c61
Author: Samael <[email protected]>
AuthorDate: Mon Nov 24 21:20:21 2025 +0000
[XERCESJ-1781] fix more Javadoc (#64)
* [XERCESJ-1781] fix more Javadoc
* [XERCESJ-1781] fix more Javadoc
* [XERCESJ-1781] fixes for PR review
* [XERCESJ-1781] fix more Javadoc
* [XERCESJ-1781] fixes for PR review
---
src/org/apache/html/dom/HTMLCollectionImpl.java | 10 +-
src/org/apache/html/dom/HTMLDocumentImpl.java | 99 +++--
src/org/apache/xerces/dom/AttributeMap.java | 89 ++---
src/org/apache/xerces/dom/CoreDocumentImpl.java | 6 +-
.../xerces/dom/DeferredEntityReferenceImpl.java | 2 +-
src/org/apache/xerces/dom/EntityReferenceImpl.java | 2 +-
src/org/apache/xerces/dom/NamedNodeMapImpl.java | 65 ++--
src/org/apache/xerces/dom/TextImpl.java | 12 +-
.../xerces/impl/XML11NSDocumentScannerImpl.java | 16 +-
.../apache/xerces/impl/dv/xs/XSSimpleTypeDecl.java | 63 ++-
src/org/apache/xerces/impl/xs/XSDDescription.java | 6 +-
.../xerces/jaxp/datatype/DatatypeFactoryImpl.java | 11 +-
.../jaxp/datatype/XMLGregorianCalendarImpl.java | 38 +-
src/org/apache/xerces/util/EncodingMap.java | 423 ++++++---------------
src/org/apache/xerces/xni/XMLString.java | 10 +-
15 files changed, 353 insertions(+), 499 deletions(-)
diff --git a/src/org/apache/html/dom/HTMLCollectionImpl.java
b/src/org/apache/html/dom/HTMLCollectionImpl.java
index db01ff98a..5c11c3240 100644
--- a/src/org/apache/html/dom/HTMLCollectionImpl.java
+++ b/src/org/apache/html/dom/HTMLCollectionImpl.java
@@ -267,7 +267,7 @@ class HTMLCollectionImpl
* and the top level element is passed along.
* <p>
* Note that this function must call itself with an index and get back both
- * the element (if one was found) and the new index which is decremeneted
+ * the element (if one was found) and the new index which is decremented
* for any like element found. Since integers are only passed by value,
* this function makes use of a separate class ({@link CollectionIndex})
* to hold that index.
@@ -473,15 +473,15 @@ class HTMLCollectionImpl
/**
- * {@link CollectionImpl#item} must traverse down the tree and decrement the
- * index until it matches an element who's index is zero. Since integers are
+ * {@link HTMLCollectionImpl#item(int)} must traverse down the tree and
decrement the
+ * index until it matches an element whose index is zero. Since integers are
* passed by value, this class servers to pass the index into each recursion
* by reference. It encompasses all the operations that need be performed on
* the index, although direct access is possible.
*
* @xerces.internal
*
- * @see CollectionImpl#item
+ * @see HTMLCollectionImpl#item(int)
*/
class CollectionIndex
{
@@ -520,7 +520,7 @@ class CollectionIndex
/**
* Constructs a new index with the specified initial value. The index will
- * then be decremeneted until it reaches zero.
+ * then be decremented until it reaches zero.
*
* @param index the initial value
*/
diff --git a/src/org/apache/html/dom/HTMLDocumentImpl.java
b/src/org/apache/html/dom/HTMLDocumentImpl.java
index 61c6366b0..69a4a49a6 100644
--- a/src/org/apache/html/dom/HTMLDocumentImpl.java
+++ b/src/org/apache/html/dom/HTMLDocumentImpl.java
@@ -143,6 +143,7 @@ public class HTMLDocumentImpl
}
+ @Override
public synchronized Element getDocumentElement()
{
Node html;
@@ -257,7 +258,12 @@ public class HTMLDocumentImpl
return (HTMLElement) head;
}
-
+ /**
+ * Get Title.
+ *
+ * @return the value in the title element or an empty string
+ */
+ @Override
public synchronized String getTitle()
{
HTMLElement head;
@@ -277,7 +283,12 @@ public class HTMLDocumentImpl
return "";
}
-
+ /**
+ * Set title.
+ *
+ * @param newTitle the new text for the title element
+ */
+ @Override
public synchronized void setTitle( String newTitle )
{
HTMLElement head;
@@ -305,7 +316,12 @@ public class HTMLDocumentImpl
}
}
-
+ /**
+ * Get Body.
+ *
+ * @return the body element of the document
+ */
+ @Override
public synchronized HTMLElement getBody()
{
Node html;
@@ -351,7 +367,12 @@ public class HTMLDocumentImpl
return (HTMLElement) body;
}
-
+ /**
+ * Set body.
+ *
+ * @param newBody the new body element for the document
+ */
+ @Override
public synchronized void setBody( HTMLElement newBody )
{
Node html;
@@ -401,7 +422,7 @@ public class HTMLDocumentImpl
}
}
-
+ @Override
public synchronized Element getElementById( String elementId )
{
Element idElement = super.getElementById(elementId);
@@ -411,19 +432,25 @@ public class HTMLDocumentImpl
return getElementById( elementId, this );
}
-
+ /**
+ * Get a list of nodes for a given element name.
+ *
+ * @param elementName the name of the element to look for
+ * @return a list of nodes with the given element name
+ */
+ @Override
public NodeList getElementsByName( String elementName )
{
return new NameNodeListImpl( this, elementName );
}
-
+ @Override
public final NodeList getElementsByTagName( String tagName )
{
return super.getElementsByTagName( tagName.toUpperCase(Locale.ENGLISH)
);
}
-
+ @Override
public final NodeList getElementsByTagNameNS( String namespaceURI,
String localName )
{
@@ -445,6 +472,7 @@ public class HTMLDocumentImpl
* @throws DOMException INVALID_CHARACTER_ERR: Raised if the specified
* name contains an invalid character
*/
+ @Override
public Element createElementNS(String namespaceURI, String qualifiedName,
String localpart)
throws DOMException
@@ -452,6 +480,7 @@ public class HTMLDocumentImpl
return createElementNS(namespaceURI, qualifiedName);
}
+ @Override
public Element createElementNS( String namespaceURI, String qualifiedName )
{
if ( namespaceURI == null || namespaceURI.length() == 0 ) {
@@ -460,7 +489,7 @@ public class HTMLDocumentImpl
return super.createElementNS( namespaceURI, qualifiedName );
}
-
+ @Override
public Element createElement( String tagName )
throws DOMException
{
@@ -510,47 +539,48 @@ public class HTMLDocumentImpl
* @return an attribute whose name is all lower case
* @throws DOMException INVALID_NAME_ERR if the attribute name is not
acceptable
*/
+ @Override
public Attr createAttribute( String name )
throws DOMException
{
return super.createAttribute( name.toLowerCase(Locale.ENGLISH) );
}
-
+ @Override
public String getReferrer()
{
// Information not available on server side.
return null;
}
-
+ @Override
public String getDomain()
{
// Information not available on server side.
return null;
}
-
+ @Override
public String getURL()
{
// Information not available on server side.
return null;
}
-
+ @Override
public String getCookie()
{
// Information not available on server side.
return null;
}
-
+ @Override
public void setCookie( String cookie )
{
// Information not available on server side.
}
-
+ @Override
public HTMLCollection getImages()
{
// For more information see HTMLCollection#collectionMatch
@@ -559,7 +589,7 @@ public class HTMLDocumentImpl
return _images;
}
-
+ @Override
public HTMLCollection getApplets()
{
// For more information see HTMLCollection#collectionMatch
@@ -568,7 +598,7 @@ public class HTMLDocumentImpl
return _applets;
}
-
+ @Override
public HTMLCollection getLinks()
{
// For more information see HTMLCollection#collectionMatch
@@ -577,7 +607,7 @@ public class HTMLDocumentImpl
return _links;
}
-
+ @Override
public HTMLCollection getForms()
{
// For more information see HTMLCollection#collectionMatch
@@ -586,7 +616,7 @@ public class HTMLDocumentImpl
return _forms;
}
-
+ @Override
public HTMLCollection getAnchors()
{
// For more information see HTMLCollection#collectionMatch
@@ -595,7 +625,10 @@ public class HTMLDocumentImpl
return _anchors;
}
-
+ /**
+ * This is a no-op in HTMLDocumentImpl
+ */
+ @Override
public void open()
{
// When called an in-memory is prepared. The document tree is still
@@ -604,7 +637,10 @@ public class HTMLDocumentImpl
_writer = new StringWriter();
}
-
+ /**
+ * This is a no-op in HTMLDocumentImpl
+ */
+ @Override
public void close()
{
// ! NOT IMPLEMENTED, REQUIRES PARSER !
@@ -614,7 +650,13 @@ public class HTMLDocumentImpl
}
}
-
+ /**
+ * Write a string.
+ * <p>This is a no-op in HTMLDocumentImpl</p>
+ *
+ * @param text a string to write
+ */
+ @Override
public void write( String text )
{
// Write a string into the in-memory writer.
@@ -622,7 +664,13 @@ public class HTMLDocumentImpl
_writer.write( text );
}
-
+ /**
+ * Write a line.
+ * <p>This is a no-op in HTMLDocumentImpl</p>
+ *
+ * @param text a string to write
+ */
+ @Override
public void writeln( String text )
{
// Write a line into the in-memory writer.
@@ -630,7 +678,7 @@ public class HTMLDocumentImpl
_writer.write( text + "\n" );
}
-
+ @Override
public Node cloneNode( boolean deep )
{
HTMLDocumentImpl newdoc = new HTMLDocumentImpl();
@@ -643,6 +691,7 @@ public class HTMLDocumentImpl
/* (non-Javadoc)
* @see CoreDocumentImpl#canRenameElements()
*/
+ @Override
protected boolean canRenameElements(String newNamespaceURI, String
newNodeName, ElementImpl el) {
if (el.getNamespaceURI() != null) {
// element is not HTML:
@@ -658,7 +707,7 @@ public class HTMLDocumentImpl
/**
- * Recursive method retreives an element by its <code>id</code> attribute.
+ * Recursive method retrieves an element by its <code>id</code> attribute.
* Called by {@link #getElementById(String)}.
*
* @param elementId the <code>id</code> value to look for
diff --git a/src/org/apache/xerces/dom/AttributeMap.java
b/src/org/apache/xerces/dom/AttributeMap.java
index 16cc27637..c5a55dcfb 100644
--- a/src/org/apache/xerces/dom/AttributeMap.java
+++ b/src/org/apache/xerces/dom/AttributeMap.java
@@ -60,15 +60,7 @@ public class AttributeMap extends NamedNodeMapImpl {
}
}
- /**
- * Adds an attribute using its nodeName attribute.
- * @see org.w3c.dom.NamedNodeMap#setNamedItem
- * @return If the new Node replaces an existing node the replaced Node is
- * returned, otherwise null is returned.
- * @param arg
- * An Attr node to store in this map.
- * @exception org.w3c.dom.DOMException The exception description.
- */
+ @Override
public Node setNamedItem(Node arg)
throws DOMException {
@@ -134,11 +126,15 @@ public class AttributeMap extends NamedNodeMapImpl {
/**
* Adds an attribute using its namespaceURI and localName.
+ *
+ * @return the replaced Node, if the new Node replaces an existing one,
otherwise null
+ * @param arg a node to store in a named node map
+ * @throws DOMException {@link DOMException#NO_MODIFICATION_ALLOWED_ERR},
+ * {@link DOMException#WRONG_DOCUMENT_ERR}, {@link
DOMException#HIERARCHY_REQUEST_ERR}, or
+ * {@link DOMException#INUSE_ATTRIBUTE_ERR}
* @see org.w3c.dom.NamedNodeMap#setNamedItem
- * @return If the new Node replaces an existing node the replaced Node is
- * returned, otherwise null is returned.
- * @param arg A node to store in a named node map.
*/
+ @Override
public Node setNamedItemNS(Node arg)
throws DOMException {
@@ -212,17 +208,16 @@ public class AttributeMap extends NamedNodeMapImpl {
/**
* Removes an attribute specified by name.
- * @param name
- * The name of a node to remove. If the
+ *
+ * @param name the name of a node to remove. If the
* removed attribute is known to have a default value, an
* attribute immediately appears containing the default value
* as well as the corresponding namespace URI, local name,
* and prefix when applicable.
- * @return The node removed from the map if a node with such a name exists.
- * @throws DOMException NOT_FOUND_ERR: Raised if there is no
node named
- * name in the map.
+ * @return the node removed from the map if a node with such a name exists
+ * @throws DOMException NOT_FOUND_ERR: if the node isn't found
*/
- /***/
+ @Override
public Node removeNamedItem(String name)
throws DOMException {
return internalRemoveNamedItem(name, true);
@@ -231,6 +226,13 @@ public class AttributeMap extends NamedNodeMapImpl {
/**
* Same as removeNamedItem except that it simply returns null if the
* specified name is not found.
+ *
+ * @param name the name of a node to remove. If the
+ * removed attribute is known to have a default value, an
+ * attribute immediately appears containing the default value
+ * as well as the corresponding namespace URI, local name,
+ * and prefix when applicable.
+ * @return the node removed from the map if a node with such a name exists
*/
Node safeRemoveNamedItem(String name) {
return internalRemoveNamedItem(name, false);
@@ -238,16 +240,16 @@ public class AttributeMap extends NamedNodeMapImpl {
/**
- * NON-DOM: Remove the node object
- *
- * NOTE: Specifically removes THIS NODE -- not the node with this
+ * NON-DOM: Remove the node object.
+ *
+ * <p>NOTE: Specifically removes THIS NODE -- not the node with this
* name, nor the node with these contents. If node does not belong to
- * this named node map, we throw a DOMException.
+ * this named node map, we throw a DOMException.</p>
*
- * @param item The node to remove
+ * @param item the node to remove
* @param addDefault true -- magically add default attribute
- * @return Removed node
- * @exception DOMException
+ * @return the removed node
+ * @throws DOMException NOT_FOUND_ERR if the node isn't found
*/
protected Node removeItem(Node item, boolean addDefault)
throws DOMException {
@@ -352,22 +354,7 @@ public class AttributeMap extends NamedNodeMapImpl {
return attr;
}
- /**
- * Introduced in DOM Level 2. <p>
- * Removes an attribute specified by local name and namespace URI.
- * @param namespaceURI
- * The namespace URI of the node to remove.
- * When it is null or an empty string, this
- * method behaves like removeNamedItem.
- * @param name The local name of the node to remove. If the
- * removed attribute is known to have a default
- * value, an attribute immediately appears
- * containing the default value.
- * @return Node The node removed from the map if a node with such
- * a local name and namespace URI exists.
- * @throws DOMException NOT_FOUND_ERR: Raised if there is no
node named
- * name in the map.
- */
+ @Override
public Node removeNamedItemNS(String namespaceURI, String name)
throws DOMException {
return internalRemoveNamedItemNS(namespaceURI, name, true);
@@ -385,10 +372,13 @@ public class AttributeMap extends NamedNodeMapImpl {
* Internal removeNamedItemNS method allowing to specify whether an
* exception must be thrown if the specified local name and namespace URI
* is not found.
+ *
+ * @param namespaceURI the namespace URI of a node to remove
+ * @param name the name of a node to remove
+ * @param raiseEx set to true for {@link DOMException#NOT_FOUND_ERR} to be
thrown node isn't found, otherwise null is returned
+ * @return an AttrImpl of the node being removed, or null
*/
- final protected Node internalRemoveNamedItemNS(String namespaceURI,
- String name,
- boolean raiseEx) {
+ final protected Node internalRemoveNamedItemNS(String namespaceURI, String
name, boolean raiseEx) {
CoreDocumentImpl ownerDocument = ownerNode.ownerDocument();
if (ownerDocument.errorChecking && isReadOnly()) {
@@ -468,11 +458,7 @@ public class AttributeMap extends NamedNodeMapImpl {
// Public methods
//
- /**
- * Cloning a NamedNodeMap is a DEEP OPERATION; it always clones
- * all the nodes contained in the map.
- */
-
+ @Override
public NamedNodeMapImpl cloneMap(NodeImpl ownerNode) {
AttributeMap newmap =
new AttributeMap((ElementImpl) ownerNode, null);
@@ -481,9 +467,7 @@ public class AttributeMap extends NamedNodeMapImpl {
return newmap;
} // cloneMap():AttributeMap
- /**
- * Override parent's method to set the ownerNode correctly
- */
+ @Override
protected void cloneContent(NamedNodeMapImpl srcmap) {
List<Node> srcnodes = srcmap.nodes;
if (srcnodes != null) {
@@ -567,6 +551,7 @@ public class AttributeMap extends NamedNodeMapImpl {
} // reconcileDefaults()
+ @Override
protected final int addItem (Node arg) {
final AttrImpl argn = (AttrImpl) arg;
diff --git a/src/org/apache/xerces/dom/CoreDocumentImpl.java
b/src/org/apache/xerces/dom/CoreDocumentImpl.java
index f377905d1..870e1c5da 100644
--- a/src/org/apache/xerces/dom/CoreDocumentImpl.java
+++ b/src/org/apache/xerces/dom/CoreDocumentImpl.java
@@ -696,9 +696,11 @@ extends ParentNode implements Document {
* which is considered the root of the actual document content. For
* HTML, where it is legal to have more than one Element at the top
* level of the document, we pick the one with the tagName
- * "HTML". For XML there should be only one top-level
+ * "HTML". For XML there should be only one top-level.
*
- * (HTML not yet supported.)
+ * <p>(HTML not yet supported.)</p>
+ *
+ * @return the root document element
*/
public Element getDocumentElement() {
if (needsSyncChildren()) {
diff --git a/src/org/apache/xerces/dom/DeferredEntityReferenceImpl.java
b/src/org/apache/xerces/dom/DeferredEntityReferenceImpl.java
index 1ca93a8d3..19ca22ff7 100644
--- a/src/org/apache/xerces/dom/DeferredEntityReferenceImpl.java
+++ b/src/org/apache/xerces/dom/DeferredEntityReferenceImpl.java
@@ -18,7 +18,7 @@
package org.apache.xerces.dom;
/**
- * EntityReference models the XML <code>&entityname;</code> syntax, when used
for
+ * EntityReference models the XML <code>&entityname;</code> syntax, when
used for
* entities defined by the DOM. Entities hardcoded into XML, such as
* character entities, should instead have been translated into text
* by the code which generated the DOM tree.
diff --git a/src/org/apache/xerces/dom/EntityReferenceImpl.java
b/src/org/apache/xerces/dom/EntityReferenceImpl.java
index 03e21ad91..da7517191 100644
--- a/src/org/apache/xerces/dom/EntityReferenceImpl.java
+++ b/src/org/apache/xerces/dom/EntityReferenceImpl.java
@@ -24,7 +24,7 @@ import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;
/**
- * EntityReference models the XML <code>&entityname;</code> syntax, when used
for
+ * EntityReference models the XML <code>&entityname;</code> syntax, when
used for
* entities defined by the DOM. Entities hardcoded into XML, such as
* character entities, should instead have been translated into text
* by the code which generated the DOM tree.
diff --git a/src/org/apache/xerces/dom/NamedNodeMapImpl.java
b/src/org/apache/xerces/dom/NamedNodeMapImpl.java
index f2beeb335..2e26760e9 100644
--- a/src/org/apache/xerces/dom/NamedNodeMapImpl.java
+++ b/src/org/apache/xerces/dom/NamedNodeMapImpl.java
@@ -161,20 +161,19 @@ public class NamedNodeMapImpl
/**
* Adds a node using its nodeName attribute.
- * As the nodeName attribute is used to derive the name which the node
must be
+ * <p>As the nodeName attribute is used to derive the name which the node
must be
* stored under, multiple nodes of certain types (those that have a
"special" string
* value) cannot be stored as the names would clash. This is seen as
preferable to
- * allowing nodes to be aliased.
- * @see org.w3c.dom.NamedNodeMap#setNamedItem
- * @return If the new Node replaces an existing node the replaced Node is
returned,
- * otherwise null is returned.
- * @param arg
- * A node to store in a named node map. The node will later be
+ * allowing nodes to be aliased.</p>
+ *
+ * @param arg A node to store in a named node map. The node will later be
* accessible using the value of the namespaceURI and localName
* attribute of the node. If a node with those namespace URI and
* local name is already present in the map, it is replaced by the new
* one.
- * @exception org.w3c.dom.DOMException The exception description.
+ * @return the replaced Node, if the new Node replaces an existing one,
otherwise null
+ * @throws org.w3c.dom.DOMException the exception description
+ * @see org.w3c.dom.NamedNodeMap#setNamedItem
*/
public Node setNamedItem(Node arg)
throws DOMException {
@@ -260,8 +259,10 @@ public class NamedNodeMapImpl
/**
* Removes a node specified by name.
- * @param name The name of a node to remove.
- * @return The node removed from the map if a node with such a name exists.
+ *
+ * @param name the name of a node to remove
+ * @return the node removed from the map if a node with such a name exists
+ * @throws DOMException NOT_FOUND_ERR: if the node isn't found
*/
public Node removeNamedItem(String name)
throws DOMException {
@@ -286,18 +287,15 @@ public class NamedNodeMapImpl
} // removeNamedItem(String):Node
/**
- * Introduced in DOM Level 2. <p>
- * Removes a node specified by local name and namespace URI.
- * @param namespaceURI
- * The namespace URI of the node to remove.
+ * Introduced in DOM Level 2.
+ * <p>Removes a node specified by local name and namespace URI.</p>
+ *
+ * @param namespaceURI the namespace URI of the node to remove.
* When it is null or an empty string, this
* method behaves like removeNamedItem.
- * @param name The local name of the node to remove.
- * @return Node The node removed from the map if a node with such
- * a local name and namespace URI exists.
- * @throws DOMException NOT_FOUND_ERR: Raised if there is no
node named
- * name in the map.
-
+ * @param name the local name of the node to remove
+ * @return Node the node removed from the map if a node with such a local
name and namespace URI exists
+ * @throws DOMException NOT_FOUND_ERR: if there is no node named name in
the map
*/
public Node removeNamedItemNS(String namespaceURI, String name)
throws DOMException {
@@ -328,14 +326,21 @@ public class NamedNodeMapImpl
/**
* Cloning a NamedNodeMap is a DEEP OPERATION; it always clones
* all the nodes contained in the map.
+ *
+ * @param ownerNode the owner node that this node's children will be
cloned to
+ * @return a collection of Nodes containing this node's children
*/
-
public NamedNodeMapImpl cloneMap(NodeImpl ownerNode) {
NamedNodeMapImpl newmap = new NamedNodeMapImpl(ownerNode);
newmap.cloneContent(this);
return newmap;
}
+ /**
+ * Override parent's method to set the ownerNode correctly.
+ *
+ * @param srcmap a NamedNodeMap whose nodes will be cloned into this
NamedNodeMap's instance
+ */
protected void cloneContent(NamedNodeMapImpl srcmap) {
List<Node> srcnodes = srcmap.nodes;
if (srcnodes != null) {
@@ -439,11 +444,12 @@ public class NamedNodeMapImpl
* Subroutine: Locate the named item, or the point at which said item
* should be added.
*
- * @param name Name of a node to look up.
+ * @param name name of a node to look up
+ * @param start the index at which to start searching the nodes in this
instance
*
* @return If positive or zero, the index of the found item.
* If negative, index of the appropriate point at which to insert
- * the item, encoded as -1-index and hence reconvertable by subtracting
+ * the item, encoded as -1-index and hence re-convertible by subtracting
* it from -1. (Encoding because I don't want to recompare the strings
* but don't want to burn bytes on a datatype to hold a flagged value.)
*/
@@ -479,7 +485,12 @@ public class NamedNodeMapImpl
} // findNamePoint(String):int
- /** This findNamePoint is for DOM Level 2 Namespaces.
+ /**
+ * This findNamePoint is for DOM Level 2 Namespaces.
+ *
+ * @param namespaceURI yhe namespace URI of the node to look up
+ * @param name name of a node to look up
+ * @return the index of the found item
*/
protected int findNamePoint(String namespaceURI, String name) {
@@ -548,6 +559,12 @@ public class NamedNodeMapImpl
return null;
}
+ /**
+ * Add item.
+ *
+ * @param arg a Node to be added
+ * @return the index at which the node has been added
+ */
protected int addItem (Node arg) {
int i = findNamePoint(arg.getNamespaceURI(), arg.getLocalName());
if (i >= 0) {
diff --git a/src/org/apache/xerces/dom/TextImpl.java
b/src/org/apache/xerces/dom/TextImpl.java
index c95e1fc50..02d019a37 100644
--- a/src/org/apache/xerces/dom/TextImpl.java
+++ b/src/org/apache/xerces/dom/TextImpl.java
@@ -601,7 +601,7 @@ public class TextImpl
* @return a reference to the new node (containing data after the offset
* point). The original node will contain data up to that point.
*
- * @throws DOMException INDEX_SIZE_ERR if offset is <0 or >length.
+ * @throws DOMException INDEX_SIZE_ERR if offset is <0 or >length.
*
* @throws DOMException NO_MODIFICATION_ALLOWED_ERR if node is read-only.
*/
@@ -639,7 +639,9 @@ public class TextImpl
/**
- * NON-DOM (used by DOMParser): Reset data for the node.
+ * NON-DOM (used by DOMParser): Reset data for the node.
+ *
+ * @param value the new value for the data
*/
public void replaceData (String value){
data = value;
@@ -647,8 +649,10 @@ public class TextImpl
/**
- * NON-DOM (used by DOMParser: Sets data to empty string.
- * Returns the value the data was set to.
+ * NON-DOM (used by DOMParser: Sets data to empty string.
+ * Returns the value the data was previously set to.
+ *
+ * @return the value the data was previously set to
*/
public String removeData (){
String olddata=data;
diff --git a/src/org/apache/xerces/impl/XML11NSDocumentScannerImpl.java
b/src/org/apache/xerces/impl/XML11NSDocumentScannerImpl.java
index b2fea39b7..407613e55 100644
--- a/src/org/apache/xerces/impl/XML11NSDocumentScannerImpl.java
+++ b/src/org/apache/xerces/impl/XML11NSDocumentScannerImpl.java
@@ -124,6 +124,7 @@ public class XML11NSDocumentScannerImpl extends
XML11DocumentScannerImpl {
*
* @return true if element is empty. (i.e. It matches production [44])
*/
+ @Override
protected boolean scanStartElement() throws IOException, XNIException {
if (DEBUG_CONTENT_SCANNING)
System.out.println(">>> scanStartElementNS()");
@@ -322,6 +323,7 @@ public class XML11NSDocumentScannerImpl extends
XML11DocumentScannerImpl {
*
* @see #scanStartElement()
*/
+ @Override
protected void scanStartElementName ()
throws IOException, XNIException {
// Note: namespace processing is on by default
@@ -336,7 +338,8 @@ public class XML11NSDocumentScannerImpl extends
XML11DocumentScannerImpl {
*
* @see #scanStartElement
* @return true if element is empty
- */
+ */
+ @Override
protected boolean scanStartElementAfterName()
throws IOException, XNIException {
@@ -691,18 +694,17 @@ public class XML11NSDocumentScannerImpl extends
XML11DocumentScannerImpl {
/**
* Scans an end element.
- * <p>
* <pre>
* [42] ETag ::= '</' Name S? '>'
* </pre>
- * <p>
- * <strong>Note:</strong> This method uses the fElementQName variable.
+ * <p><strong>Note:</strong> This method uses the fElementQName variable.
* The contents of this variable will be destroyed. The caller should
* copy the needed information out of this variable before calling
- * this method.
+ * this method.</p>
*
- * @return The element depth.
+ * @return the element depth
*/
+ @Override
protected int scanEndElement() throws IOException, XNIException {
if (DEBUG_CONTENT_SCANNING)
System.out.println(">>> scanEndElement()");
@@ -758,6 +760,7 @@ public class XML11NSDocumentScannerImpl extends
XML11DocumentScannerImpl {
} // scanEndElement():int
+ @Override
public void reset(XMLComponentManager componentManager)
throws XMLConfigurationException {
@@ -767,6 +770,7 @@ public class XML11NSDocumentScannerImpl extends
XML11DocumentScannerImpl {
}
/** Creates a content dispatcher. */
+ @Override
protected Dispatcher createContentDispatcher() {
return new NS11ContentDispatcher();
} // createContentDispatcher():Dispatcher
diff --git a/src/org/apache/xerces/impl/dv/xs/XSSimpleTypeDecl.java
b/src/org/apache/xerces/impl/dv/xs/XSSimpleTypeDecl.java
index 07f210c57..90ad90936 100644
--- a/src/org/apache/xerces/impl/dv/xs/XSSimpleTypeDecl.java
+++ b/src/org/apache/xerces/impl/dv/xs/XSSimpleTypeDecl.java
@@ -586,47 +586,58 @@ public class XSSimpleTypeDecl implements XSSimpleType,
TypeInfo {
return this;
}
+ @Override
public short getType () {
return XSConstants.TYPE_DEFINITION;
}
+ @Override
public short getTypeCategory () {
return SIMPLE_TYPE;
}
+ @Override
public String getName() {
return getAnonymous()?null:fTypeName;
}
+ @Override
public String getTypeName() {
return fTypeName;
}
+ @Override
public String getNamespace() {
return fTargetNamespace;
}
+ @Override
public short getFinal(){
return fFinalSet;
}
+ @Override
public boolean isFinal(short derivation) {
return (fFinalSet & derivation) != 0;
}
+ @Override
public XSTypeDefinition getBaseType(){
return fBase;
}
+ @Override
public boolean getAnonymous() {
return fAnonymous || (fTypeName == null);
}
+ @Override
public short getVariety(){
// for anySimpleType, return absent variaty
return fValidationDV == DV_ANYSIMPLETYPE ? VARIETY_ABSENT : fVariety;
}
+ @Override
public boolean isIDType(){
switch (fVariety) {
case VARIETY_ATOMIC:
@@ -642,6 +653,7 @@ public class XSSimpleTypeDecl implements XSSimpleType,
TypeInfo {
return false;
}
+ @Override
public short getWhitespace() throws DatatypeException{
if (fVariety == VARIETY_UNION) {
throw new DatatypeException("dt-whitespace", new
Object[]{fTypeName});
@@ -649,6 +661,7 @@ public class XSSimpleTypeDecl implements XSSimpleType,
TypeInfo {
return fWhiteSpace;
}
+ @Override
public short getPrimitiveKind() {
if (fVariety == VARIETY_ATOMIC && fValidationDV != DV_ANYSIMPLETYPE) {
if (fValidationDV == DV_ID || fValidationDV == DV_IDREF ||
fValidationDV == DV_ENTITY) {
@@ -670,20 +683,12 @@ public class XSSimpleTypeDecl implements XSSimpleType,
TypeInfo {
}
}
- /**
- * Returns the closest built-in type category this type represents or
- * derived from. For example, if this simple type is a built-in derived
- * type integer the <code>INTEGER_DV</code> is returned.
- */
+ @Override
public short getBuiltInKind() {
return this.fBuiltInKind;
}
- /**
- * If variety is <code>atomic</code> the primitive type definition (a
- * built-in primitive datatype definition or the simple ur-type
- * definition) is available, otherwise <code>null</code>.
- */
+ @Override
public XSSimpleTypeDefinition getPrimitiveType() {
if (fVariety == VARIETY_ATOMIC && fValidationDV != DV_ANYSIMPLETYPE) {
XSSimpleTypeDecl pri = this;
@@ -698,11 +703,7 @@ public class XSSimpleTypeDecl implements XSSimpleType,
TypeInfo {
}
}
- /**
- * If variety is <code>list</code> the item type definition (an atomic or
- * union simple type definition) is available, otherwise
- * <code>null</code>.
- */
+ @Override
public XSSimpleTypeDefinition getItemType() {
if (fVariety == VARIETY_LIST) {
return fItemType;
@@ -713,11 +714,7 @@ public class XSSimpleTypeDecl implements XSSimpleType,
TypeInfo {
}
}
- /**
- * If variety is <code>union</code> the list of member type definitions (a
- * non-empty sequence of simple type definitions) is available,
- * otherwise an empty <code>XSObjectList</code>.
- */
+ @Override
public XSObjectList getMemberTypes() {
if (fVariety == VARIETY_UNION) {
return new XSObjectListImpl(fMemberTypes, fMemberTypes.length);
@@ -727,9 +724,7 @@ public class XSSimpleTypeDecl implements XSSimpleType,
TypeInfo {
}
}
- /**
- * If <restriction> is chosen
- */
+ @Override
public void applyFacets(XSFacets facets, short presentFacet, short
fixedFacet, ValidationContext context)
throws InvalidDatatypeFacetException {
if (context == null) {
@@ -746,7 +741,7 @@ public class XSSimpleTypeDecl implements XSSimpleType,
TypeInfo {
try {
applyFacets(facets, presentFacet, fixedFacet,
SPECIAL_PATTERN_NONE, fDummyContext);
} catch (InvalidDatatypeFacetException e) {
- // should never gets here, internel error
+ // should never get here, internal error
throw new RuntimeException("internal error");
}
// we've now applied facets; so lock this object:
@@ -761,7 +756,7 @@ public class XSSimpleTypeDecl implements XSSimpleType,
TypeInfo {
try {
applyFacets(facets, presentFacet, fixedFacet, patternType,
fDummyContext);
} catch (InvalidDatatypeFacetException e) {
- // should never gets here, internel error
+ // should never get here, internal error
throw new RuntimeException("internal error");
}
// we've now applied facets; so lock this object:
@@ -769,7 +764,7 @@ public class XSSimpleTypeDecl implements XSSimpleType,
TypeInfo {
}
/**
- * If <restriction> is chosen, or built-in derived types by restriction
+ * If <code>restriction</code> is chosen, or built-in derived types by
restriction
*/
void applyFacets(XSFacets facets, short presentFacet, short fixedFacet,
short patternType, ValidationContext context)
throws InvalidDatatypeFacetException {
@@ -1535,9 +1530,7 @@ public class XSSimpleTypeDecl implements XSSimpleType,
TypeInfo {
} //applyFacets()
- /**
- * validate a value, and return the compiled form
- */
+ @Override
public Object validate(String content, ValidationContext context,
ValidatedInfo validatedInfo) throws InvalidDatatypeValueException {
if (context == null)
@@ -1564,7 +1557,12 @@ public class XSSimpleTypeDecl implements XSSimpleType,
TypeInfo {
}
/**
- * validate a value, and return the compiled form
+ * Validate a value, and return the compiled form.
+ *
+ * @param content the value to be validated
+ * @param context the validation context, if null is passed in the
validation context of this instance will be used
+ * @param validatedInfo if null is passed in a new instance will be created
+ * @return a validated value
*/
public ValidatedInfo validateWithInfo(String content, ValidationContext
context, ValidatedInfo validatedInfo) throws InvalidDatatypeValueException {
@@ -1586,9 +1584,7 @@ public class XSSimpleTypeDecl implements XSSimpleType,
TypeInfo {
}
- /**
- * validate a value, and return the compiled form
- */
+ @Override
public Object validate(Object content, ValidationContext context,
ValidatedInfo validatedInfo) throws InvalidDatatypeValueException {
if (context == null)
@@ -1958,6 +1954,7 @@ public class XSSimpleTypeDecl implements XSSimpleType,
TypeInfo {
}//getActualValue()
+ @Override
public boolean isEqual(Object value1, Object value2) {
if (value1 == null) {
return false;
diff --git a/src/org/apache/xerces/impl/xs/XSDDescription.java
b/src/org/apache/xerces/impl/xs/XSDDescription.java
index 2253bf4e1..c85041e80 100644
--- a/src/org/apache/xerces/impl/xs/XSDDescription.java
+++ b/src/org/apache/xerces/impl/xs/XSDDescription.java
@@ -41,17 +41,17 @@ public class XSDDescription extends
XMLResourceIdentifierImpl
*/
public final static short CONTEXT_INITIALIZE = -1;
/**
- * Indicate that the current schema document is <include>d by another
+ * Indicate that the current schema document is included by another
* schema document.
*/
public final static short CONTEXT_INCLUDE = 0;
/**
- * Indicate that the current schema document is <redefine>d by another
+ * Indicate that the current schema document is redefined by another
* schema document.
*/
public final static short CONTEXT_REDEFINE = 1;
/**
- * Indicate that the current schema document is <import>ed by another
+ * Indicate that the current schema document is imported by another
* schema document.
*/
public final static short CONTEXT_IMPORT = 2;
diff --git a/src/org/apache/xerces/jaxp/datatype/DatatypeFactoryImpl.java
b/src/org/apache/xerces/jaxp/datatype/DatatypeFactoryImpl.java
index 59244a5cc..98b1a7f50 100644
--- a/src/org/apache/xerces/jaxp/datatype/DatatypeFactoryImpl.java
+++ b/src/org/apache/xerces/jaxp/datatype/DatatypeFactoryImpl.java
@@ -96,6 +96,7 @@ public class DatatypeFactoryImpl extends DatatypeFactory {
* @throws UnsupportedOperationException If implementation cannot support
requested values.
* @throws NullPointerException if <code>lexicalRepresentation</code> is
<code>null</code>.
*/
+ @Override
public Duration newDuration(final String lexicalRepresentation) {
return new DurationImpl(lexicalRepresentation);
@@ -136,6 +137,7 @@ public class DatatypeFactoryImpl extends DatatypeFactory {
*
* @return New <code>Duration</code> representing
<code>durationInMilliseconds</code>.
*/
+ @Override
public Duration newDuration(final long durationInMilliseconds) {
return new DurationImpl(durationInMilliseconds);
@@ -168,6 +170,7 @@ public class DatatypeFactoryImpl extends DatatypeFactory {
* @see #newDuration(boolean isPositive, BigInteger years, BigInteger
months, BigInteger days,
* BigInteger hours, BigInteger minutes, BigDecimal seconds)
*/
+ @Override
public Duration newDuration(
final boolean isPositive,
final BigInteger years,
@@ -196,6 +199,7 @@ public class DatatypeFactoryImpl extends DatatypeFactory {
* @return New <code>XMLGregorianCalendar</code> with all date/time
datatype fields set to
* {@link DatatypeConstants#FIELD_UNDEFINED} or null.
*/
+ @Override
public XMLGregorianCalendar newXMLGregorianCalendar() {
return new XMLGregorianCalendarImpl();
@@ -226,6 +230,7 @@ public class DatatypeFactoryImpl extends DatatypeFactory {
* @throws IllegalArgumentException If the
<code>lexicalRepresentation</code> is not a valid
<code>XMLGregorianCalendar</code>.
* @throws NullPointerException If <code>lexicalRepresentation</code> is
<code>null</code>.
*/
+ @Override
public XMLGregorianCalendar newXMLGregorianCalendar(final String
lexicalRepresentation) {
return new XMLGregorianCalendarImpl(lexicalRepresentation);
@@ -265,8 +270,7 @@ public class DatatypeFactoryImpl extends DatatypeFactory {
* </tr>
* <tr>
* <td>
- * <code>(ZONE_OFFSET + DST_OFFSET) / (60*1000)</code><br/>
- * <em>(in minutes)</em>
+ * <code>(ZONE_OFFSET + DST_OFFSET) / (60*1000)</code> <em>(in
minutes)</em>
* </td>
* <td>{@link XMLGregorianCalendar#setTimezone(int
offset)}<sup><em>*</em></sup>
* </td>
@@ -292,6 +296,7 @@ public class DatatypeFactoryImpl extends DatatypeFactory {
*
* @throws NullPointerException if <code>cal</code> is <code>null</code>
*/
+ @Override
public XMLGregorianCalendar newXMLGregorianCalendar(final
GregorianCalendar cal) {
return new XMLGregorianCalendarImpl(cal);
@@ -323,6 +328,7 @@ public class DatatypeFactoryImpl extends DatatypeFactory {
* or if the composite values constitute an invalid
<code>XMLGregorianCalendar</code> instance
* as determined by {@link XMLGregorianCalendar#isValid()}.
*/
+ @Override
public XMLGregorianCalendar newXMLGregorianCalendar(
final int year,
final int month,
@@ -368,6 +374,7 @@ public class DatatypeFactoryImpl extends DatatypeFactory {
* @throws NullPointerException If any parameters are <code>null</code>.
*
*/
+ @Override
public XMLGregorianCalendar newXMLGregorianCalendar(
final BigInteger year,
final int month,
diff --git a/src/org/apache/xerces/jaxp/datatype/XMLGregorianCalendarImpl.java
b/src/org/apache/xerces/jaxp/datatype/XMLGregorianCalendarImpl.java
index 6d0b3f3a1..e92b67ce7 100644
--- a/src/org/apache/xerces/jaxp/datatype/XMLGregorianCalendarImpl.java
+++ b/src/org/apache/xerces/jaxp/datatype/XMLGregorianCalendarImpl.java
@@ -57,6 +57,7 @@ import org.apache.xerces.util.DatatypeMessageFormatter;
*
* <a name="datetimefieldsmapping"></a>
* <table border="1">
+ * <caption>Mappings between XML Schema 1.0 datetime fields and
XMLGregorianCalendar accessors</caption>
* <thead>
* <tr>
* <th style="text-align: center;" colspan="3">
@@ -66,22 +67,18 @@ import org.apache.xerces.util.DatatypeMessageFormatter;
* </thead>
* <tbody>
* <tr>
- * <th>XML Schema 1.0<br/>
- * datatype<br/>
- * field</th>
- * <th>Related<br/>XMLGregorianCalendar<br/>Accessor(s)</th>
+ * <th>datatype</th>
+ * <th>XMLGregorianCalendar Accessor(s)</th>
* <th>Value Range</th>
* </tr>
* <tr id="datetimefield-year">
* <td> year </td>
- * <td> {@link #getYear()} + {@link #getEon()} or<br/>
- * {@link #getEonAndYear}
- * </td>
+ * <td> {@link #getYear()} + {@link #getEon()} or {@link #getEonAndYear}
</td>
* <td> <code>getYear()</code> is a value between -(10^9-1) to (10^9)-1
- * or {@link DatatypeConstants#FIELD_UNDEFINED}.<br/>
- * {@link #getEon()} is high order year value in billion of
years.<br/>
- * <code>getEon()</code> has values greater than or equal to (10^9)
or less than or equal to -(10^9).
- * A value of null indicates field is undefined.<br/>
+ * or {@link DatatypeConstants#FIELD_UNDEFINED}.
+ * <p>{@link #getEon()} is high order year value in billion of
years.</p>
+ * <p><code>getEon()</code> has values greater than or equal to
(10^9) or less than or equal to -(10^9).
+ * A value of null indicates field is undefined.</p>
* Given that <a
href="http://www.w3.org/2001/05/xmlschema-errata#e2-63";>XML Schema 1.0
errata</a> states that the year zero
* will be a valid lexical value in a future version of XML Schema,
* this class allows the year field to be set to zero. Otherwise,
@@ -98,9 +95,9 @@ import org.apache.xerces.util.DatatypeMessageFormatter;
* <tr id="datetimefield-day">
* <td> day </td>
* <td> {@link #getDay()} </td>
- * <td> Independent of month, max range is 1 to 31 or {@link
DatatypeConstants#FIELD_UNDEFINED}.<br/>
- * The normative value constraint stated relative to month
- * field's value is in <a
href="http://www.w3.org/TR/xmlschema-2/#isoformats";>W3C XML Schema 1.0 Part 2,
Appendix D</a>.
+ * <td> Independent of month, max range is 1 to 31 or {@link
DatatypeConstants#FIELD_UNDEFINED}.
+ * <p>The normative value constraint stated relative to month
+ * field's value is in <a
href="http://www.w3.org/TR/xmlschema-2/#isoformats";>W3C XML Schema 1.0 Part 2,
Appendix D</a></p>.
* </td>
* </tr>
* <tr id="datetimefield-hour">
@@ -119,17 +116,16 @@ import org.apache.xerces.util.DatatypeMessageFormatter;
* <tr id="datetimefield-second">
* <td>second</td>
* <td>
- * {@link #getSecond()} + {@link #getMillisecond()}/1000 or<br/>
+ * {@link #getSecond()} + {@link #getMillisecond()}/1000 or
* {@link #getSecond()} + {@link #getFractionalSecond()}
* </td>
* <td>
- * {@link #getSecond()} from 0 to 60 or {@link
DatatypeConstants#FIELD_UNDEFINED}.<br/>
- * <i>(Note: 60 only allowable for leap second.)</i><br/>
+ * {@link #getSecond()} from 0 to 60 or {@link
DatatypeConstants#FIELD_UNDEFINED}.
+ * <p><i>(Note: 60 only allowable for leap second.)</i>
* {@link #getFractionalSecond()} allows for infinite precision over
the range from 0.0 to 1.0 when
- * the {@link #getSecond()} is defined.<br/>
- * <code>FractionalSecond</code> is optional and has a value of
<code>null</code> when it is undefined.<br />
- * {@link #getMillisecond()} is the convenience
- * millisecond precision of value of {@link #getFractionalSecond()}.
+ * the {@link #getSecond()} is defined.</p>
+ * <p><code>FractionalSecond</code> is optional and has a value of
<code>null</code> when it is undefined.</p>
+ * <p>{@link #getMillisecond()} is the convenience millisecond
precision of value of {@link #getFractionalSecond()}.</p>
* </td>
* </tr>
* <tr id="datetimefield-timezone">
diff --git a/src/org/apache/xerces/util/EncodingMap.java
b/src/org/apache/xerces/util/EncodingMap.java
index afaa9d943..5123394fa 100644
--- a/src/org/apache/xerces/util/EncodingMap.java
+++ b/src/org/apache/xerces/util/EncodingMap.java
@@ -24,8 +24,9 @@ import java.util.Hashtable;
* Java encoding names, and vice versa. The encoding names used in XML
instance documents
* <strong>must</strong> be the IANA encoding names specified or one of the
aliases for
* those names which IANA defines.
- * <p>
+ *
* <table>
+ * <caption>Mapping between IANA encoding names and Java encoding
names</caption>
* <tr>
* <td>
* <strong>Common Name</strong>
@@ -42,423 +43,213 @@ import java.util.Hashtable;
* </tr>
* <tr>
* <td>8 bit Unicode</td>
- * <td>
- * UTF-8
- * </td>
- * <td>
- * IANA
- * </td>
- * <td>
- * UTF8
- * </td>
+ * <td>UTF-8</td>
+ * <td>IANA</td>
+ * <td>UTF8</td>
* </tr>
* <tr>
* <td>ISO Latin 1</td>
- * <td>
- * ISO-8859-1
- * </td>
- * <td>
- * MIME
- * </td>
- * <td>
- * ISO-8859-1
- * </td>
+ * <td>ISO-8859-1</td>
+ * <td>MIME</td>
+ * <td>ISO-8859-1</td>
* </tr>
* <tr>
* <td>ISO Latin 2</td>
- * <td>
- * ISO-8859-2
- * </td>
- * <td>
- * MIME
- * </td>
- * <td>
- * ISO-8859-2
- * </td>
+ * <td>ISO-8859-2</td>
+ * <td>MIME</td>
+ * <td>ISO-8859-2</td>
* </tr>
* <tr>
* <td>ISO Latin 3</td>
- * <td>
- * ISO-8859-3
- * </td>
- * <td>
- * MIME
- * </td>
- * <td>
- * ISO-8859-3
- * </td>
+ * <td>ISO-8859-3</td>
+ * <td>MIME</td>
+ * <td>ISO-8859-3</td>
* </tr>
* <tr>
* <td>ISO Latin 4</td>
- * <td>
- * ISO-8859-4
- * </td>
- * <td>
- * MIME
- * </td>
- * <td>
- * ISO-8859-4
- * </td>
+ * <td>ISO-8859-4</td>
+ * <td>MIME</td>
+ * <td>ISO-8859-4</td>
* </tr>
* <tr>
* <td>ISO Latin Cyrillic</td>
- * <td>
- * ISO-8859-5
- * </td>
- * <td>
- * MIME
- * </td>
- * <td>
- * ISO-8859-5
- * </td>
+ * <td>ISO-8859-5</td>
+ * <td>MIME</td>
+ * <td>ISO-8859-5</td>
* </tr>
* <tr>
* <td>ISO Latin Arabic</td>
- * <td>
- * ISO-8859-6
- * </td>
- * <td>
- * MIME
- * </td>
- * <td>
- * ISO-8859-6
- * </td>
+ * <td>ISO-8859-6</td>
+ * <td>MIME</td>
+ * <td>ISO-8859-6</td>
* </tr>
* <tr>
* <td>ISO Latin Greek</td>
- * <td>
- * ISO-8859-7
- * </td>
- * <td>
- * MIME
- * </td>
- * <td>
- * ISO-8859-7
- * </td>
+ * <td>ISO-8859-7</td>
+ * <td>MIME</td>
+ * <td>ISO-8859-7</td>
* </tr>
* <tr>
* <td>ISO Latin Hebrew</td>
- * <td>
- * ISO-8859-8
- * </td>
- * <td>
- * MIME
- * </td>
- * <td>
- * ISO-8859-8
- * </td>
+ * <td>ISO-8859-8</td>
+ * <td>MIME</td>
+ * <td>ISO-8859-8</td>
* </tr>
* <tr>
* <td>ISO Latin 5</td>
- * <td>
- * ISO-8859-9
- * </td>
- * <td>
- * MIME
- * </td>
- * <td>
- * ISO-8859-9
- * </td>
+ * <td>ISO-8859-9</td>
+ * <td>MIME</td>
+ * <td>ISO-8859-9</td>
* </tr>
* <tr>
* <td>EBCDIC: US</td>
- * <td>
- * ebcdic-cp-us
- * </td>
- * <td>
- * IANA
- * </td>
- * <td>
- * cp037
- * </td>
+ * <td>ebcdic-cp-us</td>
+ * <td>IANA</td>
+ * <td>cp037</td>
* </tr>
* <tr>
* <td>EBCDIC: Canada</td>
- * <td>
- * ebcdic-cp-ca
- * </td>
- * <td>
- * IANA
- * </td>
- * <td>
- * cp037
- * </td>
+ * <td>ebcdic-cp-ca</td>
+ * <td>IANA</td>
+ * <td>cp037</td>
* </tr>
* <tr>
* <td>EBCDIC: Netherlands</td>
- * <td>
- * ebcdic-cp-nl
- * </td>
- * <td>
- * IANA
- * </td>
- * <td>
- * cp037
- * </td>
+ * <td>ebcdic-cp-nl</td>
+ * <td>IANA</td>
+ * <td>cp037</td>
* </tr>
* <tr>
* <td>EBCDIC: Denmark</td>
- * <td>
- * ebcdic-cp-dk
- * </td>
- * <td>
- * IANA
- * </td>
- * <td>
- * cp277
- * </td>
+ * <td>ebcdic-cp-dk</td>
+ * <td>IANA</td>
+ * <td>cp277</td>
* </tr>
* <tr>
* <td>EBCDIC: Norway</td>
- * <td>
- * ebcdic-cp-no
- * </td>
- * <td>
- * IANA
- * </td>
- * <td>
- * cp277
- * </td>
+ * <td>ebcdic-cp-no</td>
+ * <td>IANA</td>
+ * <td>cp277</td>
* </tr>
* <tr>
* <td>EBCDIC: Finland</td>
- * <td>
- * ebcdic-cp-fi
- * </td>
- * <td>
- * IANA
- * </td>
- * <td>
- * cp278
- * </td>
+ * <td>ebcdic-cp-fi</td>
+ * <td>IANA</td>
+ * <td>cp278</td>
* </tr>
* <tr>
* <td>EBCDIC: Sweden</td>
- * <td>
- * ebcdic-cp-se
- * </td>
- * <td>
- * IANA
- * </td>
- * <td>
- * cp278
- * </td>
+ * <td>ebcdic-cp-se</td>
+ * <td>IANA</td>
+ * <td>cp278</td>
* </tr>
* <tr>
* <td>EBCDIC: Italy</td>
- * <td>
- * ebcdic-cp-it
- * </td>
- * <td>
- * IANA
- * </td>
- * <td>
- * cp280
- * </td>
+ * <td>ebcdic-cp-it</td>
+ * <td>IANA</td>
+ * <td>cp280</td>
* </tr>
* <tr>
* <td>EBCDIC: Spain, Latin America</td>
- * <td>
- * ebcdic-cp-es
- * </td>
- * <td>
- * IANA
- * </td>
- * <td>
- * cp284
- * </td>
+ * <td>ebcdic-cp-es</td>
+ * <td>IANA</td>
+ * <td>cp284</td>
* </tr>
* <tr>
* <td>EBCDIC: Great Britain</td>
- * <td>
- * ebcdic-cp-gb
- * </td>
- * <td>
- * IANA
- * </td>
- * <td>
- * cp285
- * </td>
+ * <td>ebcdic-cp-gb</td>
+ * <td>IANA</td>
+ * <td>cp285</td>
* </tr>
* <tr>
* <td>EBCDIC: France</td>
- * <td>
- * ebcdic-cp-fr
- * </td>
- * <td>
- * IANA
- * </td>
- * <td>
- * cp297
- * </td>
+ * <td>ebcdic-cp-fr</td>
+ * <td>IANA</td>
+ * <td>cp297</td>
* </tr>
* <tr>
* <td>EBCDIC: Arabic</td>
- * <td>
- * ebcdic-cp-ar1
- * </td>
- * <td>
- * IANA
- * </td>
- * <td>
- * cp420
- * </td>
+ * <td>ebcdic-cp-ar1</td>
+ * <td>IANA</td>
+ * <td>cp420</td>
* </tr>
* <tr>
* <td>EBCDIC: Hebrew</td>
- * <td>
- * ebcdic-cp-he
- * </td>
- * <td>
- * IANA
- * </td>
- * <td>
- * cp424
- * </td>
+ * <td>ebcdic-cp-he</td>
+ * <td>IANA</td>
+ * <td>cp424</td>
* </tr>
* <tr>
* <td>EBCDIC: Switzerland</td>
- * <td>
- * ebcdic-cp-ch
- * </td>
- * <td>
- * IANA
- * </td>
- * <td>
- * cp500
- * </td>
+ * <td>ebcdic-cp-ch</td>
+ * <td>IANA</td>
+ * <td>cp500</td>
* </tr>
* <tr>
* <td>EBCDIC: Roece</td>
- * <td>
- * ebcdic-cp-roece
- * </td>
- * <td>
- * IANA
- * </td>
- * <td>
- * cp870
- * </td>
+ * <td>ebcdic-cp-roece</td>
+ * <td>IANA</td>
+ * <td>cp870</td>
* </tr>
* <tr>
* <td>EBCDIC: Yugoslavia</td>
- * <td>
- * ebcdic-cp-yu
- * </td>
- * <td>
- * IANA
- * </td>
- * <td>
- * cp870
- * </td>
+ * <td>ebcdic-cp-yu</td>
+ * <td>IANA</td>
+ * <td>cp870</td>
* </tr>
* <tr>
* <td>EBCDIC: Iceland</td>
- * <td>
- * ebcdic-cp-is
- * </td>
- * <td>
- * IANA
- * </td>
- * <td>
- * cp871
- * </td>
+ * <td>ebcdic-cp-is</td>
+ * <td>IANA</td>
+ * <td>cp871</td>
* </tr>
* <tr>
* <td>EBCDIC: Urdu</td>
- * <td>
- * ebcdic-cp-ar2
- * </td>
- * <td>
- * IANA
- * </td>
- * <td>
- * cp918
- * </td>
+ * <td>ebcdic-cp-ar2</td>
+ * <td>IANA</td>
+ * <td>cp918</td>
* </tr>
* <tr>
* <td>Chinese for PRC, mixed 1/2 byte</td>
- * <td>
- * gb2312
- * </td>
- * <td>
- * MIME
- * </td>
- * <td>
- * GB2312
- * </td>
+ * <td>gb2312</td>
+ * <td>MIME</td>
+ * <td>GB2312</td>
* </tr>
* <tr>
* <td>Extended Unix Code, packed for Japanese</td>
- * <td>
- * euc-jp
- * </td>
- * <td>
- * MIME
- * </td>
- * <td>
- * eucjis
- * </td>
+ * <td>euc-jp</td>
+ * <td>MIME</td>
+ * <td>eucjis</td>
* </tr>
* <tr>
* <td>Japanese: iso-2022-jp</td>
- * <td>
- * iso-2020-jp
- * </td>
- * <td>
- * MIME
- * </td>
- * <td>
- * JIS
- * </td>
+ * <td>iso-2020-jp</td>
+ * <td>MIME</td>
+ * <td>JIS</td>
* </tr>
* <tr>
* <td>Japanese: Shift JIS</td>
- * <td>
- * Shift_JIS
- * </td>
- * <td>
- * MIME
- * </td>
- * <td>
- * SJIS
- * </td>
+ * <td>Shift_JIS</td>
+ * <td>MIME</td>
+ * <td>SJIS</td>
* </tr>
* <tr>
* <td>Chinese: Big5</td>
- * <td>
- * Big5
- * </td>
- * <td>
- * MIME
- * </td>
- * <td>
- * Big5
- * </td>
+ * <td>Big5</td>
+ * <td>MIME</td>
+ * <td>Big5</td>
* </tr>
* <tr>
* <td>Extended Unix Code, packed for Korean</td>
- * <td>
- * euc-kr
- * </td>
- * <td>
- * MIME
- * </td>
- * <td>
- * iso2022kr
- * </td>
+ * <td>euc-kr</td>
+ * <td>MIME</td>
+ * <td>iso2022kr</td>
* </tr>
* <tr>
* <td>Cyrillic</td>
- * <td>
- * koi8-r
- * </td>
- * <td>
- * MIME
- * </td>
- * <td>
- * koi8-r
- * </td>
+ * <td>koi8-r</td>
+ * <td>MIME</td>
+ * <td>koi8-r</td>
* </tr>
* </table>
*
diff --git a/src/org/apache/xerces/xni/XMLString.java
b/src/org/apache/xerces/xni/XMLString.java
index 015c32159..80709d159 100644
--- a/src/org/apache/xerces/xni/XMLString.java
+++ b/src/org/apache/xerces/xni/XMLString.java
@@ -112,15 +112,17 @@ public class XMLString {
* of the given string structure.
* <p>
* <strong>Note:</strong> This does not copy the character array;
- * only the reference to the array is copied.
- *
- * @param s
+ * only the reference to the array is copied.</p>
+ *
+ * @param s an XML string structure to copy
*/
public void setValues(XMLString s) {
setValues(s.ch, s.offset, s.length);
} // setValues(XMLString)
- /** Resets all of the values to their defaults. */
+ /**
+ * Resets all the values to their defaults.
+ */
public void clear() {
this.ch = null;
this.offset = 0;
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
