mmidy 00/11/30 14:59:00
Modified: java/src/org/apache/xml/utils MutableAttrListImpl.java
NameSpace.java NodeVector.java ObjectPool.java
PrefixResolverDefault.java QName.java
RawCharacterHandler.java SAXSourceLocator.java
StringKey.java StringToIntTable.java
StringToStringTable.java
StringToStringTableVector.java StringVector.java
Log:
Update javadoc
Revision Changes Path
1.2 +3 -3
xml-xalan/java/src/org/apache/xml/utils/MutableAttrListImpl.java
Index: MutableAttrListImpl.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xml/utils/MutableAttrListImpl.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- MutableAttrListImpl.java 2000/11/23 04:58:45 1.1
+++ MutableAttrListImpl.java 2000/11/30 22:58:48 1.2
@@ -129,7 +129,7 @@
/**
* Add the contents of the attribute list to this list.
*
- * NEEDSDOC @param atts
+ * @param atts List of attributes to add to this list
*/
public void addAttributes(Attributes atts)
{
@@ -159,9 +159,9 @@
/**
* Return true if list contains the given (raw) attribute name.
*
- * NEEDSDOC @param name
+ * @param name Raw name of attribute to look for
*
- * NEEDSDOC ($objectName$) @return
+ * @return true if an attribute is found with this name
*/
public boolean contains(String name)
{
1.2 +5 -5 xml-xalan/java/src/org/apache/xml/utils/NameSpace.java
Index: NameSpace.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xml/utils/NameSpace.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- NameSpace.java 2000/11/23 04:58:45 1.1
+++ NameSpace.java 2000/11/30 22:58:49 1.2
@@ -67,21 +67,21 @@
public class NameSpace implements Serializable
{
- /** NEEDSDOC Field m_next */
+ /** Next NameSpace element on the stack */
public NameSpace m_next = null;
- /** NEEDSDOC Field m_prefix */
+ /** Prefix of this NameSpace element */
public String m_prefix;
- /** NEEDSDOC Field m_uri */
+ /** Namespace URI of this NameSpace element */
public String m_uri; // if null, then Element namespace is empty.
/**
* Construct a namespace for placement on the
* result tree namespace stack.
*
- * NEEDSDOC @param prefix
- * NEEDSDOC @param uri
+ * @param prefix Prefix of this element
+ * @param uri URI of this element
*/
public NameSpace(String prefix, String uri)
{
1.2 +40 -33 xml-xalan/java/src/org/apache/xml/utils/NodeVector.java
Index: NodeVector.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xml/utils/NodeVector.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- NodeVector.java 2000/11/23 04:58:45 1.1
+++ NodeVector.java 2000/11/30 22:58:49 1.2
@@ -67,16 +67,16 @@
public class NodeVector implements Serializable, Cloneable
{
- /** NEEDSDOC Field m_blocksize */
+ /** Size of blocks to allocate */
private int m_blocksize;
- /** NEEDSDOC Field m_map[] */
+ /** Array of nodes this points to */
private Node m_map[];
- /** NEEDSDOC Field m_firstFree */
+ /** Number of nodes in this NodeVector */
protected int m_firstFree = 0;
- /** NEEDSDOC Field m_mapSize */
+ /** Size of the array this points to */
private int m_mapSize; // lazy initialization
/**
@@ -91,7 +91,7 @@
/**
* Construct a NodeVector, using the given block size.
*
- * NEEDSDOC @param blocksize
+ * @param blocksize Size of blocks to allocate
*/
public NodeVector(int blocksize)
{
@@ -102,7 +102,7 @@
/**
* Get a cloned LocPathIterator.
*
- * NEEDSDOC ($objectName$) @return
+ * @return A clone of this
*
* @throws CloneNotSupportedException
*/
@@ -124,7 +124,7 @@
/**
* Get the length of the list.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Number of nodes in this NodeVector
*/
public int size()
{
@@ -134,7 +134,7 @@
/**
* Append a Node onto the vector.
*
- * NEEDSDOC @param value
+ * @param value Node to add to the vector
*/
public void addElement(Node value)
{
@@ -166,7 +166,7 @@
/**
* Append a Node onto the vector.
*
- * NEEDSDOC @param value
+ * @param value Node to add to the vector
*/
public final void push(Node value)
{
@@ -202,7 +202,7 @@
/**
* Pop a node from the tail of the vector and return the result.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the node at the tail of the vector
*/
public final Node pop()
{
@@ -220,7 +220,7 @@
* Pop a node from the tail of the vector and return the
* top of the stack after the pop.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The top of the stack after it's been popped
*/
public final Node popAndTop()
{
@@ -244,10 +244,11 @@
}
/**
+ * Return the node at the top of the stack without popping the stack.
* Special purpose method for TransformerImpl, pushElemTemplateElement.
* Performance critical.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Node at the top of the stack or null if stack is empty.
*/
public final Node peepOrNull()
{
@@ -256,11 +257,12 @@
}
/**
+ * Push a pair of nodes into the stack.
* Special purpose method for TransformerImpl, pushElemTemplateElement.
* Performance critical.
*
- * NEEDSDOC @param v1
- * NEEDSDOC @param v2
+ * @param v1 First node to add to vector
+ * @param v2 Second node to add to vector
*/
public final void pushPair(Node v1, Node v2)
{
@@ -290,6 +292,7 @@
}
/**
+ * Pop a pair of nodes from the tail of the stack.
* Special purpose method for TransformerImpl, pushElemTemplateElement.
* Performance critical.
*/
@@ -302,10 +305,11 @@
}
/**
+ * Set the tail of the stack to the given node.
* Special purpose method for TransformerImpl, pushElemTemplateElement.
* Performance critical.
*
- * NEEDSDOC @param n
+ * @param n Node to set at the tail of vector
*/
public final void setTail(Node n)
{
@@ -313,10 +317,11 @@
}
/**
+ * Set the given node one position from the tail.
* Special purpose method for TransformerImpl, pushElemTemplateElement.
* Performance critical.
*
- * NEEDSDOC @param n
+ * @param n Node to set
*/
public final void setTailSub1(Node n)
{
@@ -324,10 +329,11 @@
}
/**
+ * Return the node at the tail of the vector without popping
* Special purpose method for TransformerImpl, pushElemTemplateElement.
* Performance critical.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Node at the tail of the vector
*/
public final Node peepTail()
{
@@ -335,10 +341,11 @@
}
/**
+ * Return the node one position from the tail without popping.
* Special purpose method for TransformerImpl, pushElemTemplateElement.
* Performance critical.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Node one away from the tail
*/
public final Node peepTailSub1()
{
@@ -351,8 +358,8 @@
* the specified index is shifted upward to have an index one greater
* than the value it had previously.
*
- * NEEDSDOC @param value
- * NEEDSDOC @param at
+ * @param value Node to insert
+ * @param at Position where to insert
*/
public void insertElementAt(Node value, int at)
{
@@ -386,7 +393,7 @@
/**
* Append the nodes to the list.
*
- * NEEDSDOC @param nodes
+ * @param nodes NodeVector to append to this list
*/
public void appendNodes(NodeVector nodes)
{
@@ -441,9 +448,9 @@
* downward to have an index one smaller than the value it had
* previously.
*
- * NEEDSDOC @param s
+ * @param s Node to remove from the list
*
- * NEEDSDOC ($objectName$) @return
+ * @return True if the node was successfully removed
*/
public boolean removeElement(Node s)
{
@@ -477,7 +484,7 @@
* index is shifted downward to have an index one smaller than
* the value it had previously.
*
- * NEEDSDOC @param i
+ * @param i Index of node to remove
*/
public void removeElementAt(int i)
{
@@ -498,8 +505,8 @@
* The index must be a value greater than or equal to 0 and less
* than the current size of the vector.
*
- * NEEDSDOC @param node
- * NEEDSDOC @param index
+ * @param node Node to set
+ * @param index Index of where to set the node
*/
public void setElementAt(Node node, int index)
{
@@ -516,9 +523,9 @@
/**
* Get the nth element.
*
- * NEEDSDOC @param i
+ * @param i Index of node to get
*
- * NEEDSDOC ($objectName$) @return
+ * @return Node at specified index
*/
public Node elementAt(int i)
{
@@ -532,9 +539,9 @@
/**
* Tell if the table contains the given node.
*
- * NEEDSDOC @param s
+ * @param s Node to look for
*
- * NEEDSDOC ($objectName$) @return
+ * @return True if the given node was found.
*/
public boolean contains(Node s)
{
@@ -558,8 +565,8 @@
* beginning the search at index, and testing for equality
* using the equals method.
*
- * NEEDSDOC @param elem
- * NEEDSDOC @param index
+ * @param elem Node to look for
+ * @param index Index of where to start the search
* @return the index of the first occurrence of the object
* argument in this vector at position index or later in the
* vector; returns -1 if the object is not found.
@@ -586,7 +593,7 @@
* beginning the search at index, and testing for equality
* using the equals method.
*
- * NEEDSDOC @param elem
+ * @param elem Node to look for
* @return the index of the first occurrence of the object
* argument in this vector at position index or later in the
* vector; returns -1 if the object is not found.
1.2 +12 -12 xml-xalan/java/src/org/apache/xml/utils/ObjectPool.java
Index: ObjectPool.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xml/utils/ObjectPool.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ObjectPool.java 2000/11/23 04:58:45 1.1
+++ ObjectPool.java 2000/11/30 22:58:50 1.2
@@ -60,22 +60,22 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class ObjectPool <needs-comment/>
+ * Pool of object of a given type to pick from to help memory usage
*/
public class ObjectPool implements java.io.Serializable
{
- /** NEEDSDOC Field objectType */
+ /** Type of objects in this pool */
private final Class objectType;
- /** NEEDSDOC Field freeStack */
+ /** Vector of given objects this points to */
private final Vector freeStack;
/**
* Constructor ObjectPool
*
*
- * NEEDSDOC @param type
+ * @param type Type of objects for this pool
*/
public ObjectPool(Class type)
{
@@ -87,8 +87,8 @@
* Constructor ObjectPool
*
*
- * NEEDSDOC @param type
- * NEEDSDOC @param size
+ * @param type Type of objects for this pool
+ * @param size Size of vector to allocate
*/
public ObjectPool(Class type, int size)
{
@@ -107,10 +107,10 @@
}
/**
- * NEEDSDOC Method getInstanceIfFree
+ * Get an instance of the given object in this pool if available
*
*
- * NEEDSDOC (getInstanceIfFree) @return
+ * @return an instance of the given object if available or null
*/
public synchronized Object getInstanceIfFree()
{
@@ -131,10 +131,10 @@
}
/**
- * NEEDSDOC Method getInstance
+ * Get an instance of the given object in this pool
*
*
- * NEEDSDOC (getInstance) @return
+ * @return An instance of the given object
*/
public synchronized Object getInstance()
{
@@ -167,10 +167,10 @@
}
/**
- * NEEDSDOC Method freeInstance
+ * Add an instance of the given object to the pool
*
*
- * NEEDSDOC @param obj
+ * @param obj Object to add.
*/
public synchronized void freeInstance(Object obj)
{
1.2 +1 -1
xml-xalan/java/src/org/apache/xml/utils/PrefixResolverDefault.java
Index: PrefixResolverDefault.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xml/utils/PrefixResolverDefault.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- PrefixResolverDefault.java 2000/11/23 04:58:45 1.1
+++ PrefixResolverDefault.java 2000/11/30 22:58:50 1.2
@@ -173,7 +173,7 @@
/**
* Return the base identifier.
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public String getBaseIdentifier()
{
1.4 +31 -31 xml-xalan/java/src/org/apache/xml/utils/QName.java
Index: QName.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xml/utils/QName.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- QName.java 2000/11/27 05:14:36 1.3
+++ QName.java 2000/11/30 22:58:52 1.4
@@ -154,7 +154,7 @@
* Construct a QName from a string, without namespace resolution. Good
* for a few odd cases.
*
- * NEEDSDOC @param localName
+ * @param localName Local part of qualified name
*/
public QName(String localName)
{
@@ -172,8 +172,8 @@
* using the given namespace stack. The default namespace is
* not resolved.
*
- * NEEDSDOC @param qname
- * NEEDSDOC @param namespaces
+ * @param qname Qualified name to resolve
+ * @param namespaces Namespace stack to use to resolve namespace
*/
public QName(String qname, Stack namespaces)
{
@@ -235,12 +235,12 @@
/**
* Construct a QName from a string, resolving the prefix
- * using the given namespace stack. The default namespace is
- * not resolved.
- *
- * NEEDSDOC @param qname
- * NEEDSDOC @param namespaceContext
- * NEEDSDOC @param resolver
+ * using the given namespace context and prefix resolver.
+ * The default namespace is not resolved.
+ *
+ * @param qname Qualified name to resolve
+ * @param namespaceContext Namespace Context to use
+ * @param resolver Prefix resolver for this context
*/
public QName(String qname, Element namespaceContext,
PrefixResolver resolver)
@@ -293,8 +293,8 @@
* using the given namespace stack. The default namespace is
* not resolved.
*
- * NEEDSDOC @param qname
- * NEEDSDOC @param resolver
+ * @param qname Qualified name to resolve
+ * @param resolver Prefix resolver for this context
*/
public QName(String qname, PrefixResolver resolver)
{
@@ -366,7 +366,7 @@
* Return the string representation of the namespace. Performs
* string concatenation, so beware of performance issues.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the string representation of the namespace
*/
public String toString()
{
@@ -380,7 +380,7 @@
/**
* Get the namespace of the qualified name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the namespace URI of the qualified name
*/
public String getNamespace()
{
@@ -390,7 +390,7 @@
/**
* Get the local part of the qualified name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the local part of the qualified name
*/
public String getLocalPart()
{
@@ -400,7 +400,7 @@
/**
* Return the cached hashcode of the qualified name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the cached hashcode of the qualified name
*/
public int hashCode()
{
@@ -412,10 +412,10 @@
* the passed object is a string and it matches
* the name of the arg.
*
- * NEEDSDOC @param ns
- * NEEDSDOC @param localPart
+ * @param ns Namespace URI to compare to
+ * @param localPart Local part of qualified name to compare to
*
- * NEEDSDOC ($objectName$) @return
+ * @return True if the local name and uri match
*/
public boolean equals(String ns, String localPart)
{
@@ -433,9 +433,9 @@
* the passed object is a QName and it matches
* the name of the arg.
*
- * NEEDSDOC @param qname
+ * @param qname Qualified name to compare to
*
- * NEEDSDOC ($objectName$) @return
+ * @return True if the qualified names are equal
*/
public boolean equals(Object object)
{
@@ -458,12 +458,12 @@
}
/**
- * NEEDSDOC Method getQNameFromString
+ * Given a string, create and return a QName object
*
*
- * NEEDSDOC @param name
+ * @param name String to use to create QName
*
- * NEEDSDOC (getQNameFromString) @return
+ * @return a QName object
*/
public static QName getQNameFromString(String name)
{
@@ -485,9 +485,9 @@
* This function tells if a raw attribute name is a
* xmlns attribute.
*
- * NEEDSDOC @param attRawName
+ * @param attRawName Raw name of attribute
*
- * NEEDSDOC ($objectName$) @return
+ * @return True if the attribute starts with or is equal to xmlns
*/
public static boolean isXMLNSDecl(String attRawName)
{
@@ -501,9 +501,9 @@
* This function tells if a raw attribute name is a
* xmlns attribute.
*
- * NEEDSDOC @param attRawName
+ * @param attRawName Raw name of attribute
*
- * NEEDSDOC ($objectName$) @return
+ * @return Prefix of attribute
*/
public static String getPrefixFromXMLNSDecl(String attRawName)
{
@@ -516,9 +516,9 @@
/**
* Returns the local name of the given node.
*
- * NEEDSDOC @param qname
+ * @param qname Input name
*
- * NEEDSDOC ($objectName$) @return
+ * @return Local part of the name if prefixed, or the given name if not
*/
public static String getLocalPart(String qname)
{
@@ -531,9 +531,9 @@
/**
* Returns the local name of the given node.
*
- * NEEDSDOC @param qname
+ * @param qname Input name
*
- * NEEDSDOC ($objectName$) @return
+ * @return Prefix of name or empty string if none there
*/
public static String getPrefixPart(String qname)
{
1.2 +3 -3
xml-xalan/java/src/org/apache/xml/utils/RawCharacterHandler.java
Index: RawCharacterHandler.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xml/utils/RawCharacterHandler.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- RawCharacterHandler.java 2000/11/23 04:58:45 1.1
+++ RawCharacterHandler.java 2000/11/30 22:58:52 1.2
@@ -67,9 +67,9 @@
/**
* Serialize the characters without escaping.
*
- * NEEDSDOC @param ch
- * NEEDSDOC @param start
- * NEEDSDOC @param length
+ * @param ch Array of characters
+ * @param start Start index of characters in the array
+ * @param length Number of characters in the array
*
* @throws javax.xml.transform.TransformerException
*/
1.2 +1 -1
xml-xalan/java/src/org/apache/xml/utils/SAXSourceLocator.java
Index: SAXSourceLocator.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xml/utils/SAXSourceLocator.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- SAXSourceLocator.java 2000/11/23 04:58:45 1.1
+++ SAXSourceLocator.java 2000/11/30 22:58:52 1.2
@@ -83,7 +83,7 @@
* Constructor SAXSourceLocator
*
*
- * NEEDSDOC @param locator
+ * @param locator Source locator
*/
public SAXSourceLocator(Locator locator)
{
1.2 +8 -8 xml-xalan/java/src/org/apache/xml/utils/StringKey.java
Index: StringKey.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xml/utils/StringKey.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- StringKey.java 2000/11/23 04:58:45 1.1
+++ StringKey.java 2000/11/30 22:58:53 1.2
@@ -64,17 +64,17 @@
public class StringKey extends Object
{
- /** NEEDSDOC Field m_str */
+ /** String value */
private String m_str;
- /** NEEDSDOC Field m_hash */
+ /** Hash value of the string */
int m_hash;
/**
* Constructor StringKey
*
*
- * NEEDSDOC @param key
+ * @param key String value to cache
*/
public StringKey(String key)
{
@@ -83,10 +83,10 @@
}
/**
- * NEEDSDOC Method hashCode
+ * Get the hash value of the string
*
*
- * NEEDSDOC (hashCode) @return
+ * @return hash value of the string
*/
public int hashCode()
{
@@ -94,12 +94,12 @@
}
/**
- * NEEDSDOC Method equals
+ * Override of equals() for this object
*
*
- * NEEDSDOC @param obj
+ * @param obj to compare to
*
- * NEEDSDOC (equals) @return
+ * @return True if this object equals this string value
*/
public final boolean equals(Object obj)
{
1.2 +18 -16
xml-xalan/java/src/org/apache/xml/utils/StringToIntTable.java
Index: StringToIntTable.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xml/utils/StringToIntTable.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- StringToIntTable.java 2000/11/23 04:58:45 1.1
+++ StringToIntTable.java 2000/11/30 22:58:53 1.2
@@ -64,19 +64,21 @@
public class StringToIntTable
{
- /** NEEDSDOC Field m_blocksize */
+ /** Block size to allocate */
private int m_blocksize;
- /** NEEDSDOC Field m_map[] */
+ /** Array of strings this table points to. Associated with ints
+ * in m_values */
private String m_map[];
- /** NEEDSDOC Field m_values[] */
+ /** Array of ints this table points. Associated with strings from
+ * m_map. */
private int m_values[];
- /** NEEDSDOC Field m_firstFree */
+ /** Number of ints in the table */
private int m_firstFree = 0;
- /** NEEDSDOC Field m_mapSize */
+ /** Size of this table */
private int m_mapSize;
/**
@@ -95,7 +97,7 @@
/**
* Construct a StringToIntTable, using the given block size.
*
- * NEEDSDOC @param blocksize
+ * @param blocksize Size of block to allocate
*/
public StringToIntTable(int blocksize)
{
@@ -109,7 +111,7 @@
/**
* Get the length of the list.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the length of the list
*/
public final int getLength()
{
@@ -119,8 +121,8 @@
/**
* Append a string onto the vector.
*
- * NEEDSDOC @param key
- * NEEDSDOC @param value
+ * @param key String to append
+ * @param value The int value of the string
*/
public final void put(String key, int value)
{
@@ -151,9 +153,9 @@
/**
* Tell if the table contains the given string.
*
- * NEEDSDOC @param key
+ * @param key String to look for
*
- * NEEDSDOC ($objectName$) @return
+ * @return The String's int value or a bogus value if not found
*/
public final int get(String key)
{
@@ -168,11 +170,11 @@
}
/**
- * Tell if the table contains the given string.
+ * Tell if the table contains the given string. Ignore case.
*
- * NEEDSDOC @param key
+ * @param key String to look for
*
- * NEEDSDOC ($objectName$) @return
+ * @return The string's int value, or a bogus value if not found
*/
public final int getIgnoreCase(String key)
{
@@ -192,9 +194,9 @@
/**
* Tell if the table contains the given string.
*
- * NEEDSDOC @param key
+ * @param key String to look for
*
- * NEEDSDOC ($objectName$) @return
+ * @return True if the string is in the table
*/
public final boolean contains(String key)
{
1.2 +25 -23
xml-xalan/java/src/org/apache/xml/utils/StringToStringTable.java
Index: StringToStringTable.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xml/utils/StringToStringTable.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- StringToStringTable.java 2000/11/23 04:58:45 1.1
+++ StringToStringTable.java 2000/11/30 22:58:53 1.2
@@ -64,16 +64,16 @@
public class StringToStringTable
{
- /** NEEDSDOC Field m_blocksize */
+ /** Size of blocks to allocate */
private int m_blocksize;
- /** NEEDSDOC Field m_map[] */
+ /** Array of strings this contains */
private String m_map[];
- /** NEEDSDOC Field m_firstFree */
+ /** Number of strings this contains */
private int m_firstFree = 0;
- /** NEEDSDOC Field m_mapSize */
+ /** Size of this table */
private int m_mapSize;
/**
@@ -91,7 +91,7 @@
/**
* Construct a StringToStringTable, using the given block size.
*
- * NEEDSDOC @param blocksize
+ * @param blocksize Size of blocks to allocate
*/
public StringToStringTable(int blocksize)
{
@@ -104,7 +104,7 @@
/**
* Get the length of the list.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Number of strings in the list
*/
public final int getLength()
{
@@ -113,9 +113,11 @@
/**
* Append a string onto the vector.
+ * The strings go to the even locations in the array
+ * and the values in the odd.
*
- * NEEDSDOC @param key
- * NEEDSDOC @param value
+ * @param key String to add to the list
+ * @param value Value of the string
*/
public final void put(String key, String value)
{
@@ -143,9 +145,9 @@
/**
* Tell if the table contains the given string.
*
- * NEEDSDOC @param key
+ * @param key String to look up
*
- * NEEDSDOC ($objectName$) @return
+ * @return return the value of the string or null if not found.
*/
public final String get(String key)
{
@@ -160,9 +162,9 @@
}
/**
- * Tell if the table contains the given string.
+ * Remove the given string and its value from this table.
*
- * NEEDSDOC @param key
+ * @param key String to remove from the table
*/
public final void remove(String key)
{
@@ -184,11 +186,11 @@
}
/**
- * Tell if the table contains the given string.
+ * Tell if the table contains the given string. Ignore case
*
- * NEEDSDOC @param key
+ * @param key String to look up
*
- * NEEDSDOC ($objectName$) @return
+ * @return The value of the string or null if not found
*/
public final String getIgnoreCase(String key)
{
@@ -208,9 +210,9 @@
/**
* Tell if the table contains the given string in the value.
*
- * NEEDSDOC @param val
+ * @param val Value of the string to look up
*
- * NEEDSDOC ($objectName$) @return
+ * @return the string associated with the given value or null if not found
*/
public final String getByValue(String val)
{
@@ -227,9 +229,9 @@
/**
* Get the nth element.
*
- * NEEDSDOC @param i
+ * @param i index of the string to look up.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The string at the given index.
*/
public final String elementAt(int i)
{
@@ -239,9 +241,9 @@
/**
* Tell if the table contains the given string.
*
- * NEEDSDOC @param key
+ * @param key String to look up
*
- * NEEDSDOC ($objectName$) @return
+ * @return True if the given string is in this table
*/
public final boolean contains(String key)
{
@@ -258,9 +260,9 @@
/**
* Tell if the table contains the given string.
*
- * NEEDSDOC @param val
+ * @param val value to look up
*
- * NEEDSDOC ($objectName$) @return
+ * @return True if the given value is in the table.
*/
public final boolean containsValue(String val)
{
1.2 +20 -19
xml-xalan/java/src/org/apache/xml/utils/StringToStringTableVector.java
Index: StringToStringTableVector.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xml/utils/StringToStringTableVector.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- StringToStringTableVector.java 2000/11/23 04:58:45 1.1
+++ StringToStringTableVector.java 2000/11/30 22:58:54 1.2
@@ -64,16 +64,16 @@
public class StringToStringTableVector
{
- /** NEEDSDOC Field m_blocksize */
+ /** Size of blocks to allocate */
private int m_blocksize;
- /** NEEDSDOC Field m_map[] */
+ /** Array of StringToStringTable objects */
private StringToStringTable m_map[];
- /** NEEDSDOC Field m_firstFree */
+ /** Number of StringToStringTable objects in this array */
private int m_firstFree = 0;
- /** NEEDSDOC Field m_mapSize */
+ /** Size of this array */
private int m_mapSize;
/**
@@ -91,7 +91,7 @@
/**
* Construct a StringToStringTableVector, using the given block size.
*
- * NEEDSDOC @param blocksize
+ * @param blocksize Size of blocks to allocate
*/
public StringToStringTableVector(int blocksize)
{
@@ -104,7 +104,7 @@
/**
* Get the length of the list.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Number of StringToStringTable objects in the list
*/
public final int getLength()
{
@@ -114,7 +114,7 @@
/**
* Get the length of the list.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Number of StringToStringTable objects in the list
*/
public final int size()
{
@@ -122,9 +122,9 @@
}
/**
- * Append a string onto the vector.
+ * Append a StringToStringTable object onto the vector.
*
- * NEEDSDOC @param value
+ * @param value StringToStringTable object to add
*/
public final void addElement(StringToStringTable value)
{
@@ -149,9 +149,10 @@
* Given a string, find the last added occurance value
* that matches the key.
*
- * NEEDSDOC @param key
+ * @param key String to look up
*
- * NEEDSDOC ($objectName$) @return
+ * @return the last added occurance value that matches the key
+ * or null if not found.
*/
public final String get(String key)
{
@@ -168,12 +169,12 @@
}
/**
- * Given a string, find the last added occurance value
+ * Given a string, find out if there is a value in this table
* that matches the key.
*
- * NEEDSDOC @param key
+ * @param key String to look for
*
- * NEEDSDOC ($objectName$) @return
+ * @return True if the string was found in table, null if not
*/
public final boolean containsKey(String key)
{
@@ -204,9 +205,9 @@
/**
* Get the nth element.
*
- * NEEDSDOC @param i
+ * @param i Index of element to find
*
- * NEEDSDOC ($objectName$) @return
+ * @return The StringToStringTable object at the given index
*/
public final StringToStringTable elementAt(int i)
{
@@ -214,11 +215,11 @@
}
/**
- * Tell if the table contains the given string.
+ * Tell if the table contains the given StringToStringTable.
*
- * NEEDSDOC @param s
+ * @param s The StringToStringTable to find
*
- * NEEDSDOC ($objectName$) @return
+ * @return True if the StringToStringTable is found
*/
public final boolean contains(StringToStringTable s)
{
1.2 +21 -20 xml-xalan/java/src/org/apache/xml/utils/StringVector.java
Index: StringVector.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xml/utils/StringVector.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- StringVector.java 2000/11/23 04:58:45 1.1
+++ StringVector.java 2000/11/30 22:58:54 1.2
@@ -64,16 +64,16 @@
public class StringVector
{
- /** NEEDSDOC Field m_blocksize */
+ /** Size of blocks to allocate */
protected int m_blocksize;
- /** NEEDSDOC Field m_map[] */
+ /** Array of strings this contains */
protected String m_map[];
- /** NEEDSDOC Field m_firstFree */
+ /** Number of strings this contains */
protected int m_firstFree = 0;
- /** NEEDSDOC Field m_mapSize */
+ /** Size of the array */
protected int m_mapSize;
/**
@@ -91,7 +91,7 @@
/**
* Construct a StringVector, using the given block size.
*
- * NEEDSDOC @param blocksize
+ * @param blocksize Size of the blocks to allocate
*/
public StringVector(int blocksize)
{
@@ -104,7 +104,7 @@
/**
* Get the length of the list.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Number of strings in the list
*/
public int getLength()
{
@@ -114,7 +114,7 @@
/**
* Get the length of the list.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Number of strings in the list
*/
public final int size()
{
@@ -124,7 +124,7 @@
/**
* Append a string onto the vector.
*
- * NEEDSDOC @param value
+ * @param value Sting to add to the vector
*/
public final void addElement(String value)
{
@@ -148,9 +148,9 @@
/**
* Get the nth element.
*
- * NEEDSDOC @param i
+ * @param i Index of string to find
*
- * NEEDSDOC ($objectName$) @return
+ * @return String at given index
*/
public final String elementAt(int i)
{
@@ -160,9 +160,9 @@
/**
* Tell if the table contains the given string.
*
- * NEEDSDOC @param s
+ * @param s String to look for
*
- * NEEDSDOC ($objectName$) @return
+ * @return True if the string is in this table
*/
public final boolean contains(String s)
{
@@ -180,11 +180,11 @@
}
/**
- * Tell if the table contains the given string.
+ * Tell if the table contains the given string. Ignore case.
*
- * NEEDSDOC @param s
+ * @param s String to find
*
- * NEEDSDOC ($objectName$) @return
+ * @return True if the String is in this vector
*/
public final boolean containsIgnoreCase(String s)
{
@@ -204,7 +204,7 @@
/**
* Tell if the table contains the given string.
*
- * NEEDSDOC @param s
+ * @param s String to push into the vector
*/
public final void push(String s)
{
@@ -226,9 +226,10 @@
}
/**
- * Tell if the table contains the given string.
+ * Pop the tail of this vector.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The String last added to this vector or null not found.
+ * The string is removed from the vector.
*/
public final String pop()
{
@@ -246,9 +247,9 @@
}
/**
- * Tell if the table contains the given string.
+ * Get the string at the tail of this vector without popping.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The string at the tail of this vector.
*/
public final String peek()
{
