[Biojava-l] Typos ..

Tony Watkins tony_watkins@ntlworld.com
Wed, 13 Feb 2002 11:11:09 +0000


package org.biojava.utils.cache

Class FixedSizeCache

method makeReference

(Original)

Construct a temporary reference to an object. The reference persists until 
it becomes dereferenced itself, it is explicitly cleared by the user, or 
the cache determines that it is a candidate for disposal.

(suggested changes)

... The reference persists until it becomes *de-referenced*, *is explicitly 
cleared by the user*, or the cache determines that it is a candidate for 
disposal.

package org.biojava.utils.stax

Interface StAXContentHandler
(original)
Interface for StAX content handlers. This interface is very similar in 
spirit and design to the SAX content handler. differance are:

(suggested correction)
Interface for StAX content handlers. This interface is very similar in 
spirit and design to the SAX content handler. *The differences* are:

Class BooleanElementHandlerBase

(original)
StAX handler for any element which just contains a string representation of 
an booleaneger

This calss collects the string data, and when it is complete, passes it to 
the (abstract) setBooleanValue method.

(suggested corrections)
StAX handler for any element which just contains a string representation of 
an *boolean*

This *class* collects the string data, and when it is complete, passes it 
to the (abstract) setBooleanValue method.

Class ByteElementHandlerBase

(original)
This calss collects the string data, and when it is complete, passes it to 
the (abstract) setByteValue method

(suggested correction)
This class collects the string data, and when it is complete, passes it to 
the (abstract) setByteValue method

Class CharElementHandlerBase

(original)
This calss collects the string data, and when it is complete, passes it to 
the (abstract) setCharValue method.

(suggested correction)
This class collects the string data, and when it is complete, passes it to 
the (abstract) setCharValue method.

[methinks I see a pattern emerging ... ;)]

Class DoubleElementHandlerBase

(original)
This calss collects the string data, and when it is complete, passes it to 
the (abstract) setDoubleValue method

(suggested correction)
This *class* collects the string data, and when it is complete, passes it 
to the (abstract) setDoubleValue method

Class LongElementHandlerBase

(original)
This calss collects the string data, and when it is complete, passes it to 
the (abstract) setLongValue method

(suggested correction)
This *class* collects the string data, and when it is complete, passes it 
to the (abstract) setLongValue method

Package org.biojava.utils.xml

Description
(original)
This package contains a number of utilities for processing XML documents. 
Currently, the main contents are the XMLPeerBuilder system, a simple but 
configurable method for constructing hierarchies of Java objects bases on XML.

(suggested correction)
... Currently, the main contents are the XMLPeerBuilder system, a simple 
but configurable method for constructing hierarchies of Java objects 
*based* on XML.


Interface XMLPeerFactory

(original)
Interface to an factory which produces Java objects which reflect element 
in an XML document

(suggested correction)
Interface to *a* factory which produces Java objects which reflect element 
in an XML document

Class XMLDispatcher

(original)
Simple implementation of XMLPeerFactory which delegates object- 
construction on the basis of tag name

(suggested correction)
Simple implementation of XMLPeerFactory which delegates *object* 
construction on the basis of tag name

Class XMLPeerBuilder

(original)
SAX DocumentHandler which uses an XMLPeerFactory to construct Java objects 
reflecting an XML document. The XMLPeerBuilder system takes a depth-first 
approach to constructing the Object tree. This means that, before 
attempting to construct an Object to represent a particular element, it 
first constructs Objects for all child elelments

(suggested correction)
... This means that, before attempting to construct an Object to represent 
a particular element, it first constructs Objects for all child *elements*

Ok - I have crossed eyes and an addled brain.

Laters ...