Bommels05/commons-xml
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix a whole bunch of JavaDoc problems, mostly 1.4.x 'first sentence' errors on my part

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/xml/commons/trunk@226053 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
ndw 2003-02-17 12:45:03 +00:00
parent 1cdfd4dfde
commit 8086ef5f62
32 changed files with 279 additions and 279 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

135
java/src/org/apache/xml/resolver/Catalog.java
View File

@ -78,7 +78,7 @@ import org.apache.xml.resolver.readers.OASISXMLCatalogReader;
import javax.xml.parsers.SAXParserFactory;
/**
* <p>Represents OASIS Open Catalog files.</p>
* Represents OASIS Open Catalog files.
*
* <p>This class implements the semantics of OASIS Open Catalog files
* (defined by
@ -220,58 +220,58 @@ import javax.xml.parsers.SAXParserFactory;
* Inc.</p>
*/
public class Catalog {
/** The BASE Catalog Entry type */
/** The BASE Catalog Entry type. */
public static final int BASE = CatalogEntry.addEntryType("BASE", 1);
/** The CATALOG Catalog Entry type */
/** The CATALOG Catalog Entry type. */
public static final int CATALOG = CatalogEntry.addEntryType("CATALOG", 1);
/** The DOCUMENT Catalog Entry type */
/** The DOCUMENT Catalog Entry type. */
public static final int DOCUMENT = CatalogEntry.addEntryType("DOCUMENT", 1);
/** The OVERRIDE Catalog Entry type */
/** The OVERRIDE Catalog Entry type. */
public static final int OVERRIDE = CatalogEntry.addEntryType("OVERRIDE", 1);
/** The SGMLDECL Catalog Entry type */
/** The SGMLDECL Catalog Entry type. */
public static final int SGMLDECL = CatalogEntry.addEntryType("SGMLDECL", 1);
/** The DELEGATE_PUBLIC Catalog Entry type */
/** The DELEGATE_PUBLIC Catalog Entry type. */
public static final int DELEGATE_PUBLIC = CatalogEntry.addEntryType("DELEGATE_PUBLIC", 2);
/** The DELEGATE_SYSTEM Catalog Entry type */
/** The DELEGATE_SYSTEM Catalog Entry type. */
public static final int DELEGATE_SYSTEM = CatalogEntry.addEntryType("DELEGATE_SYSTEM", 2);
/** The DELEGATE_URI Catalog Entry type */
/** The DELEGATE_URI Catalog Entry type. */
public static final int DELEGATE_URI = CatalogEntry.addEntryType("DELEGATE_URI", 2);
/** The DOCTYPE Catalog Entry type */
/** The DOCTYPE Catalog Entry type. */
public static final int DOCTYPE = CatalogEntry.addEntryType("DOCTYPE", 2);
/** The DTDDECL Catalog Entry type */
/** The DTDDECL Catalog Entry type. */
public static final int DTDDECL = CatalogEntry.addEntryType("DTDDECL", 2);
/** The ENTITY Catalog Entry type */
/** The ENTITY Catalog Entry type. */
public static final int ENTITY = CatalogEntry.addEntryType("ENTITY", 2);
/** The LINKTYPE Catalog Entry type */
/** The LINKTYPE Catalog Entry type. */
public static final int LINKTYPE = CatalogEntry.addEntryType("LINKTYPE", 2);
/** The NOTATION Catalog Entry type */
/** The NOTATION Catalog Entry type. */
public static final int NOTATION = CatalogEntry.addEntryType("NOTATION", 2);
/** The PUBLIC Catalog Entry type */
/** The PUBLIC Catalog Entry type. */
public static final int PUBLIC = CatalogEntry.addEntryType("PUBLIC", 2);
/** The SYSTEM Catalog Entry type */
/** The SYSTEM Catalog Entry type. */
public static final int SYSTEM = CatalogEntry.addEntryType("SYSTEM", 2);
/** The URI Catalog Entry type */
/** The URI Catalog Entry type. */
public static final int URI = CatalogEntry.addEntryType("URI", 2);
/** The REWRITE_SYSTEM Catalog Entry type */
/** The REWRITE_SYSTEM Catalog Entry type. */
public static final int REWRITE_SYSTEM = CatalogEntry.addEntryType("REWRITE_SYSTEM", 2);
/** The REWRITE_URI Catalog Entry type */
/** The REWRITE_URI Catalog Entry type. */
public static final int REWRITE_URI = CatalogEntry.addEntryType("REWRITE_URI", 2);
/**
@ -289,11 +289,11 @@ public class Catalog {
/** The default initial override setting. */
protected boolean default_override = true;
/** The catalog manager in use for this instance */
/** The catalog manager in use for this instance. */
protected CatalogManager catalogManager = CatalogManager.getStaticManager();
/**
* <p>A vector of catalog files to be loaded.</p>
* A vector of catalog files to be loaded.
*
* <p>This list is initially established by
* <code>loadSystemCatalogs</code> when
@ -306,8 +306,8 @@ public class Catalog {
protected Vector catalogFiles = new Vector();
/**
* <p>A vector of catalog files constructed during processing of
* CATALOG entries in the current catalog.</p>
* A vector of catalog files constructed during processing of
* CATALOG entries in the current catalog.
*
* <p>This two-level system is actually necessary to correctly implement
* the semantics of the CATALOG entry. If one catalog file includes
@ -325,7 +325,7 @@ public class Catalog {
protected Vector localCatalogFiles = new Vector();
/**
* <p>A vector of Catalogs.</p>
* A vector of Catalogs.
*
* <p>The semantics of Catalog resolution are such that each
* catalog is effectively a list of Catalogs (in other words,
@ -344,8 +344,8 @@ public class Catalog {
protected Vector catalogs = new Vector();
/**
* <p>A vector of DELEGATE* Catalog entries constructed during
* processing of the Catalog.</p>
* A vector of DELEGATE* Catalog entries constructed during
* processing of the Catalog.
*
* <p>This two-level system has two purposes; first, it allows
* us to sort the DELEGATE* entries by the length of the partial
@ -361,7 +361,7 @@ public class Catalog {
protected Vector localDelegate = new Vector();
/**
* <p>A hash of CatalogReaders.</p>
* A hash of CatalogReaders.
*
* <p>This hash maps MIME types to elements in the readerArr
* vector. This allows the Catalog to quickly locate the reader
@ -370,7 +370,7 @@ public class Catalog {
protected Hashtable readerMap = new Hashtable();
/**
* <p>A vector of CatalogReaders.</p>
* A vector of CatalogReaders.
*
* <p>This vector contains all of the readers in the order that they
* were added. In the event that a catalog is read from a file, where
@ -380,7 +380,7 @@ public class Catalog {
protected Vector readerArr = new Vector();
/**
* <p>Constructs an empty Catalog.</p>
* Constructs an empty Catalog.
*
* <p>The constructor interrogates the relevant system properties
* using the default (static) CatalogManager
@ -391,7 +391,7 @@ public class Catalog {
}
/**
* <p>Constructs an empty Catalog with a specific CatalogManager.</p>
* Constructs an empty Catalog with a specific CatalogManager.
*
* <p>The constructor interrogates the relevant system properties
* using the specified Catalog Manager
@ -418,7 +418,7 @@ public class Catalog {
}
/**
* <p>Setup readers.</p>
* Setup readers.
*/
public void setupReaders() {
SAXParserFactory spf = SAXParserFactory.newInstance();
@ -441,7 +441,7 @@ public class Catalog {
}
/**
* <p>Add a new CatalogReader to the Catalog.</p>
* Add a new CatalogReader to the Catalog.
*
* <p>This method allows you to add a new CatalogReader to the
* catalog. The reader will be associated with the specified mimeType.
@ -472,7 +472,7 @@ public class Catalog {
}
/**
* <p>Copies the reader list from the current Catalog to a new Catalog</p>
* Copies the reader list from the current Catalog to a new Catalog.
*
* <p>This method is used internally when constructing a new catalog.
* It copies the current reader associations over to the new catalog.
@ -506,7 +506,7 @@ public class Catalog {
}
/**
* <p>Create a new Catalog object.</p>
* Create a new Catalog object.
*
* <p>This method constructs a new instance of the running Catalog
* class (which might be a subtype of org.apache.xml.resolver.Catalog).
@ -544,15 +544,15 @@ public class Catalog {
}
/**
* <p>Returns the current base URI.</p>
* Returns the current base URI.
*/
public String getCurrentBase() {
return base.toString();
}
/**
* <p>Returns the default override setting associated with this
* catalog.</p>
* Returns the default override setting associated with this
* catalog.
*
* <p>All catalog files loaded by this catalog will have the
* initial override setting specified by this default.</p>
@ -566,7 +566,7 @@ public class Catalog {
}
/**
* <p>Load the system catalog files.</p>
* Load the system catalog files.
*
* <p>The method adds all of the
* catalogs specified in the <tt>xml.catalog.files</tt> property
@ -605,7 +605,7 @@ public class Catalog {
}
/**
* <p>Parse a catalog file, augmenting internal data structures</p>
* Parse a catalog file, augmenting internal data structures.
*
* @param fileName The filename of the catalog file to process
*
@ -629,7 +629,7 @@ public class Catalog {
}
/**
* <p>Parse a catalog file, augmenting internal data structures</p>
* Parse a catalog file, augmenting internal data structures.
*
* <p>Catalogs retrieved over the net may have an associated MIME type.
* The MIME type can be used to select an appropriate reader.</p>
@ -667,7 +667,7 @@ public class Catalog {
}
/**
* <p>Parse a catalog document, augmenting internal data structures</p>
* Parse a catalog document, augmenting internal data structures.
*
* <p>This method supports catalog files stored in jar files: e.g.,
* jar:file:///path/to/filename.jar!/path/to/catalog.xml". That URI
@ -675,10 +675,11 @@ public class Catalog {
* the parseCatalog(String) performs and passing it as an input stream
* doesn't set the base URI appropriately.</p>
*
* <p>Written by Stefan Wachter (2002-09-26)</p>
*
* @param aUrl The URL of the catalog document to process
*
* @throws IOException Error reading catalog file.
* @author Stefan Wachter (2002-09-26)
*/
public synchronized void parseCatalog(URL aUrl) throws IOException {
catalogCwd = aUrl;
@ -723,7 +724,7 @@ public class Catalog {
}
/**
* <p>Parse all of the pending catalogs.</p>
* Parse all of the pending catalogs.
*
* <p>Catalogs may refer to other catalogs, this method parses
* all of the currently pending catalog files.</p>
@ -819,7 +820,7 @@ public class Catalog {
}
/**
* <p>Parse a single catalog file, augmenting internal data structures</p>
* Parse a single catalog file, augmenting internal data structures.
*
* @param fileName The filename of the catalog file to process
*
@ -908,7 +909,7 @@ public class Catalog {
}
/**
* <p>Cleanup and process a Catalog entry.</p>
* Cleanup and process a Catalog entry.
*
* <p>This method processes each Catalog entry, changing mapped
* relative system identifiers into absolute ones (based on the current
@ -1092,7 +1093,7 @@ public class Catalog {
}
/**
* <p>Handle unknown CatalogEntry types.</p>
* Handle unknown CatalogEntry types.
*
* <p>This method exists to allow subclasses to deal with unknown
* entry types.</p>
@ -1105,7 +1106,7 @@ public class Catalog {
}
/**
* <p>Parse all subordinate catalogs.</p>
* Parse all subordinate catalogs.
*
* <p>This method recursively parses all of the subordinate catalogs.
* If this method does not throw an exception, you can be confident that
@ -1167,7 +1168,7 @@ public class Catalog {
/**
* <p>Return the applicable DOCTYPE system identifier.</p>
* Return the applicable DOCTYPE system identifier.
*
* @param entityName The name of the entity (element) for which
* a doctype is required.
@ -1253,7 +1254,7 @@ public class Catalog {
}
/**
* <p>Return the applicable DOCUMENT entry.</p>
* Return the applicable DOCUMENT entry.
*
* @return The system identifier to use for the doctype.
*
@ -1280,7 +1281,7 @@ public class Catalog {
}
/**
* <p>Return the applicable ENTITY system identifier.</p>
* Return the applicable ENTITY system identifier.
*
* @param entityName The name of the entity for which
* a system identifier is required.
@ -1366,7 +1367,7 @@ public class Catalog {
}
/**
* <p>Return the applicable NOTATION system identifier.</p>
* Return the applicable NOTATION system identifier.
*
* @param notationName The name of the notation for which
* a doctype is required.
@ -1452,7 +1453,7 @@ public class Catalog {
}
/**
* <p>Return the applicable PUBLIC or SYSTEM identifier.</p>
* Return the applicable PUBLIC or SYSTEM identifier.
*
* <p>This method searches the Catalog and returns the system
* identifier specified for the given system or
@ -1521,7 +1522,7 @@ public class Catalog {
}
/**
* <p>Return the applicable PUBLIC or SYSTEM identifier</p>
* Return the applicable PUBLIC or SYSTEM identifier.
*
* <p>This method searches the Catalog and returns the system
* identifier specified for the given system or public identifiers.
@ -1653,7 +1654,7 @@ public class Catalog {
}
/**
* <p>Return the applicable SYSTEM system identifier</p>
* Return the applicable SYSTEM system identifier.
*
* <p>If a SYSTEM entry exists in the Catalog
* for the system ID specified, return the mapped value.</p>
@ -1698,8 +1699,8 @@ public class Catalog {
}
/**
* <p>Return the applicable SYSTEM system identifier in this
* catalog.</p>
* Return the applicable SYSTEM system identifier in this
* catalog.
*
* <p>If a SYSTEM entry exists in the catalog file
* for the system ID specified, return the mapped value.</p>
@ -1793,7 +1794,7 @@ public class Catalog {
}
/**
* <p>Return the applicable URI</p>
* Return the applicable URI.
*
* <p>If a URI entry exists in the Catalog
* for the URI specified, return the mapped value.</p>
@ -1836,8 +1837,7 @@ public class Catalog {
}
/**
* <p>Return the applicable URI in this
* catalog.</p>
* Return the applicable URI in this catalog.
*
* <p>If a URI entry exists in the catalog file
* for the URI specified, return the mapped value.</p>
@ -1926,8 +1926,7 @@ public class Catalog {
}
/**
* <p>Search the subordinate catalogs, in order, looking for a
* match.</p>
* Search the subordinate catalogs, in order, looking for a match.
*
* <p>This method searches the Catalog and returns the system
* identifier specified for the given entity type with the given
@ -2019,8 +2018,8 @@ public class Catalog {
// -----------------------------------------------------------------
/**
* <p>Replace backslashes with forward slashes. (URLs always use
* forward slashes.)</p>
* Replace backslashes with forward slashes. (URLs always use
* forward slashes.)
*
* @param sysid The input system identifier.
* @return The same system identifier with backslashes turned into
@ -2031,8 +2030,8 @@ public class Catalog {
}
/**
* <p>Construct an absolute URI from a relative one, using the current
* base URI.</p>
* Construct an absolute URI from a relative one, using the current
* base URI.
*
* @param sysid The (possibly relative) system identifier
* @return The system identifier made absolute with respect to the
@ -2057,7 +2056,7 @@ public class Catalog {
}
/**
* <p>Perform character normalization on a URI reference.</p>
* Perform character normalization on a URI reference.
*
* @param uriref The URI reference
* @return The normalized URI reference.
@ -2103,7 +2102,7 @@ public class Catalog {
}
/**
* <p>Perform %-encoding on a single byte.</p>
* Perform %-encoding on a single byte.
*
* @param b The 8-bit integer that represents th byte. (Bytes are signed
but encoding needs to look at the bytes unsigned.)
@ -2121,7 +2120,7 @@ public class Catalog {
// -----------------------------------------------------------------
/**
* <p>Add to the current list of delegated catalogs.</p>
* Add to the current list of delegated catalogs.
*
* <p>This method always constructs the {@link #localDelegate}
* vector so that it is ordered by length of partial

22
java/src/org/apache/xml/resolver/CatalogEntry.java
View File

@ -63,7 +63,7 @@ import java.util.Hashtable;
import java.util.Vector;
/**
* <p>Represents a Catalog entry.</p>
* Represents a Catalog entry.
*
* <p>Instances of this class represent individual entries
* in a Catalog.</p>
@ -104,7 +104,7 @@ public class CatalogEntry {
protected static Vector entryArgs = new Vector();
/**
* <p>Adds a new catalog entry type.</p>
* Adds a new catalog entry type.
*
* @param name The name of the catalog entry type. This must be
* unique among all types and is case-sensitive. (Adding a duplicate
@ -123,7 +123,7 @@ public class CatalogEntry {
}
/**
* <p>Lookup an entry type</p>
* Lookup an entry type
*
* @param name The name of the catalog entry type.
* @return The type of the catalog entry with the specified name.
@ -146,7 +146,7 @@ public class CatalogEntry {
}
/**
* <p>Find out how many arguments an entry is required to have.</p>
* Find out how many arguments an entry is required to have.
*
* @param name The name of the catalog entry type.
* @return The number of arguments that entry type is required to have.
@ -159,7 +159,7 @@ public class CatalogEntry {
}
/**
* <p>Find out how many arguments an entry is required to have.</p>
* Find out how many arguments an entry is required to have.
*
* @param type A valid catalog entry type.
* @return The number of arguments that entry type is required to have.
@ -182,12 +182,12 @@ public class CatalogEntry {
protected Vector args = null;
/**
* <p>Null constructor; something for subclasses to call.</p>
* Null constructor; something for subclasses to call.
*/
public CatalogEntry() {}
/**
* <p>Construct a catalog entry of the specified type.</p>
* Construct a catalog entry of the specified type.
*
* @param name The name of the entry type
* @param args A String Vector of arguments
@ -220,7 +220,7 @@ public class CatalogEntry {
}
/**
* <p>Construct a catalog entry of the specified type.</p>
* Construct a catalog entry of the specified type.
*
* @param name The name of the entry type
* @param args A String Vector of arguments
@ -245,7 +245,7 @@ public class CatalogEntry {
}
/**
* <p>Get the entry type.</p>
* Get the entry type.
*
* @return The entry type of the CatalogEntry
*/
@ -254,7 +254,7 @@ public class CatalogEntry {
}
/**
* <p>Get an entry argument.</p>
* Get an entry argument.
*
* @param argNum The argument number (arguments are numbered from 0).
* @return The specified argument or null if an invalid argNum is
@ -270,7 +270,7 @@ public class CatalogEntry {
}
/**
* <p>Set an entry argument.</p>
* Set an entry argument.
*
* <p>Catalogs sometimes need to adjust the catlog entry parameters,
* for example to make a relative URI absolute with respect to the

2
java/src/org/apache/xml/resolver/CatalogException.java
View File

@ -60,7 +60,7 @@
package org.apache.xml.resolver;
/**
* <p>Signal Catalog exception.</p>
* Signal Catalog exception.
*
* <p>This exception is thrown if an error occurs loading a
* catalog file.</p>

30
java/src/org/apache/xml/resolver/CatalogManager.java
View File

@ -69,7 +69,7 @@ import org.apache.xml.resolver.helpers.Debug;
import org.apache.xml.resolver.Catalog;
/**
* <p>CatalogManager provides an interface to the catalog properties.</p>
* CatalogManager provides an interface to the catalog properties.
*
* <p>Properties can come from two places: from system properties or
* from a <i>CatalogManager.properties</i> file. This class provides a transparent
@ -343,7 +343,7 @@ public class CatalogManager {
/**
* Obtain the verbosity setting from the properties.
*
* @returns The verbosity level from the propertyFile or the
* @return The verbosity level from the propertyFile or the
* defaultVerbosity.
*/
private int queryVerbosity () {
@ -399,7 +399,7 @@ public class CatalogManager {
/**
* Obtain the relativeCatalogs setting from the properties.
*
* @returns The relativeCatalogs setting from the propertyFile or the
* @return The relativeCatalogs setting from the propertyFile or the
* defaultRelativeCatalogs.
*/
private boolean queryRelativeCatalogs () {
@ -434,7 +434,7 @@ public class CatalogManager {
* <p>In the properties, a value of 'yes', 'true', or '1' is considered
* true, anything else is false.</p>
*
* @returns The relativeCatalogs setting from the propertyFile or the
* @return The relativeCatalogs setting from the propertyFile or the
* defaultRelativeCatalogs.
*/
public boolean getRelativeCatalogs () {
@ -448,7 +448,7 @@ public class CatalogManager {
/**
* Set the relativeCatalogs setting.
*
* @returns The relativeCatalogs setting from the propertyFile or the
* @return The relativeCatalogs setting from the propertyFile or the
* defaultRelativeCatalogs.
*
* @see #getRelativeCatalogs()
@ -469,7 +469,7 @@ public class CatalogManager {
/**
* Obtain the list of catalog files from the properties.
*
* @returns A semicolon delimited list of catlog file URIs
* @return A semicolon delimited list of catlog file URIs
*/
private String queryCatalogFiles () {
String catalogList = System.getProperty(pFiles);
@ -498,7 +498,7 @@ public class CatalogManager {
/**
* Return the current list of catalog files.
*
* @returns A vector of the catalog file names or null if no catalogs
* @return A vector of the catalog file names or null if no catalogs
* are available in the properties.
*/
public Vector getCatalogFiles() {
@ -538,7 +538,7 @@ public class CatalogManager {
/**
* Return the current list of catalog files.
*
* @returns A vector of the catalog file names or null if no catalogs
* @return A vector of the catalog file names or null if no catalogs
* are available in the properties.
*
* @deprecated No longer static; use get/set methods.
@ -553,7 +553,7 @@ public class CatalogManager {
* <p>In the properties, a value of 'public' is true,
* anything else is false.</p>
*
* @returns True if prefer is public or the
* @return True if prefer is public or the
* defaultPreferSetting.
*/
private boolean queryPreferPublic () {
@ -579,7 +579,7 @@ public class CatalogManager {
/**
* Return the current prefer public setting.
*
* @returns True if public identifiers are preferred.
* @return True if public identifiers are preferred.
*/
public boolean getPreferPublic () {
if (preferPublic == null) {
@ -591,7 +591,7 @@ public class CatalogManager {
/**
* Set the prefer public setting.
*
* @returns True if public identifiers are preferred.
* @return True if public identifiers are preferred.
*/
public void setPreferPublic (boolean preferPublic) {
this.preferPublic = new Boolean(preferPublic);
@ -600,7 +600,7 @@ public class CatalogManager {
/**
* Return the current prefer public setting.
*
* @returns True if public identifiers are preferred.
* @return True if public identifiers are preferred.
*
* @deprecated No longer static; use get/set methods.
*/
@ -614,7 +614,7 @@ public class CatalogManager {
* <p>In the properties, a value of 'yes', 'true', or '1' is considered
* true, anything else is false.</p>
*
* @returns The static-catalog setting from the propertyFile or the
* @return The static-catalog setting from the propertyFile or the
* defaultUseStaticCatalog.
*/
private boolean queryUseStaticCatalog () {
@ -745,7 +745,7 @@ public class CatalogManager {
* <p>In the properties, a value of 'yes', 'true', or '1' is considered
* true, anything else is false.</p>
*
* @returns The oasisXMLCatalogPI setting from the propertyFile or the
* @return The oasisXMLCatalogPI setting from the propertyFile or the
* defaultOasisXMLCatalogPI.
*/
public boolean queryAllowOasisXMLCatalogPI () {
@ -798,7 +798,7 @@ public class CatalogManager {
}
/**
* <p>Obtain the Catalog class name setting from the properties.</p>
* Obtain the Catalog class name setting from the properties.
*
*/
public String queryCatalogClassName () {

50
java/src/org/apache/xml/resolver/Resolver.java
View File

@ -73,8 +73,8 @@ import org.apache.xml.resolver.readers.TR9401CatalogReader;
import javax.xml.parsers.SAXParserFactory;
/**
* <p>An extension to OASIS Open Catalog files, this class supports
* suffix-based matching and an external RFC2483 resolver.</p>
* An extension to OASIS Open Catalog files, this class supports
* suffix-based matching and an external RFC2483 resolver.
*
* @see Catalog
*
@ -85,14 +85,14 @@ import javax.xml.parsers.SAXParserFactory;
*/
public class Resolver extends Catalog {
/**
* <p>The URISUFFIX Catalog Entry type.</p>
* The URISUFFIX Catalog Entry type.
*
* <p>URI suffix entries match URIs that end in a specified suffix.</p>
*/
public static final int URISUFFIX = CatalogEntry.addEntryType("URISUFFIX", 2);
/**
* <p>The SYSTEMSUFFIX Catalog Entry type.</p>
* The SYSTEMSUFFIX Catalog Entry type.
*
* <p>System suffix entries match system identifiers that end in a
* specified suffix.</p>
@ -100,14 +100,14 @@ public class Resolver extends Catalog {
public static final int SYSTEMSUFFIX = CatalogEntry.addEntryType("SYSTEMSUFFIX", 2);
/**
* <p>The RESOLVER Catalog Entry type.</p>
* The RESOLVER Catalog Entry type.
*
* <p>A hook for providing support for web-based backup resolvers.</p>
*/
public static final int RESOLVER = CatalogEntry.addEntryType("RESOLVER", 1);
/**
* <p>The SYSTEMREVERSE Catalog Entry type.</p>
* The SYSTEMREVERSE Catalog Entry type.
*
* <p>This is a bit of a hack. There's no actual SYSTEMREVERSE entry,
* but this entry type is used to indicate that a reverse lookup is
@ -118,7 +118,7 @@ public class Resolver extends Catalog {
= CatalogEntry.addEntryType("SYSTEMREVERSE", 1);
/**
* <p>Setup readers.</p>
* Setup readers.
*/
public void setupReaders() {
SAXParserFactory spf = SAXParserFactory.newInstance();
@ -141,7 +141,7 @@ public class Resolver extends Catalog {
}
/**
* <p>Cleanup and process a Catalog entry.</p>
* Cleanup and process a Catalog entry.
*
* <p>This method processes each Catalog entry, changing mapped
* relative system identifiers into absolute ones (based on the current
@ -173,7 +173,7 @@ public class Resolver extends Catalog {
}
/**
* <p>Return the applicable URI</p>
* Return the applicable URI.
*
* <p>If a URI entry exists in the Catalog
* for the URI specified, return the mapped value.</p>
@ -227,8 +227,8 @@ public class Resolver extends Catalog {
}
/**
* <p>Return the applicable SYSTEM system identifier, resorting
* to external RESOLVERs if necessary.</p>
* Return the applicable SYSTEM system identifier, resorting
* to external RESOLVERs if necessary.
*
* <p>If a SYSTEM entry exists in the Catalog
* for the system ID specified, return the mapped value.</p>
@ -283,8 +283,8 @@ public class Resolver extends Catalog {
}
/**
* <p>Return the applicable PUBLIC or SYSTEM identifier, resorting
* to external resolvers if necessary.</p>
* Return the applicable PUBLIC or SYSTEM identifier, resorting
* to external resolvers if necessary.
*
* <p>This method searches the Catalog and returns the system
* identifier specified for the given system or
@ -344,7 +344,7 @@ public class Resolver extends Catalog {
}
/**
* <p>Query an external RFC2483 resolver for a system identifier.</p>
* Query an external RFC2483 resolver for a system identifier.
*
* @param systemId The system ID to locate.
* @param resolver The name of the resolver to use.
@ -362,7 +362,7 @@ public class Resolver extends Catalog {
}
/**
* <p>Query an external RFC2483 resolver for a public identifier.</p>
* Query an external RFC2483 resolver for a public identifier.
*
* @param publicId The system ID to locate.
* @param resolver The name of the resolver to use.
@ -380,7 +380,7 @@ public class Resolver extends Catalog {
}
/**
* <p>Query an external RFC2483 resolver.</p>
* Query an external RFC2483 resolver.
*
* @param resolver The URL of the RFC2483 resolver.
* @param command The command to send the resolver.
@ -436,7 +436,7 @@ public class Resolver extends Catalog {
}
/**
* <p>Append two vectors, returning the result.</p>
* Append two vectors, returning the result.
*
* @param vec The first vector
* @param appvec The vector to be appended
@ -452,7 +452,7 @@ public class Resolver extends Catalog {
}
/**
* <p>Find the URNs for a given system identifier in all catalogs.</p>
* Find the URNs for a given system identifier in all catalogs.
*
* @param systemId The system ID to locate.
*
@ -478,7 +478,7 @@ public class Resolver extends Catalog {
}
/**
* <p>Find the URN for a given system identifier.</p>
* Find the URN for a given system identifier.
*
* @param systemId The system ID to locate.
*
@ -495,7 +495,7 @@ public class Resolver extends Catalog {
}
/**
* <p>Return the applicable SYSTEM system identifiers</p>
* Return the applicable SYSTEM system identifiers.
*
* <p>If one or more SYSTEM entries exists in the Catalog
* for the system ID specified, return the mapped values.</p>
@ -546,8 +546,8 @@ public class Resolver extends Catalog {
}
/**
* <p>Return all applicable SYSTEM system identifiers in this
* catalog.</p>
* Return all applicable SYSTEM system identifiers in this
* catalog.
*
* <p>If one or more SYSTEM entries exists in the catalog file
* for the system ID specified, return the mapped values.</p>
@ -578,7 +578,7 @@ public class Resolver extends Catalog {
}
/**
* <p>Find the URNs for a given system identifier in the current catalog.</p>
* Find the URNs for a given system identifier in the current catalog.
*
* @param systemId The system ID to locate.
*
@ -606,8 +606,8 @@ public class Resolver extends Catalog {
}
/**
* <p>Search the subordinate catalogs, in order, looking for all
* match.</p>
* Search the subordinate catalogs, in order, looking for all
* match.
*
* <p>This method searches the Catalog and returns all of the system
* identifiers specified for the given entity type with the given

2
java/src/org/apache/xml/resolver/apps/XParseError.java
View File

@ -66,7 +66,7 @@ import org.xml.sax.*;
import org.xml.sax.helpers.*;
/**
* <p>An ErrorHandler for xparse.</p>
* An ErrorHandler for xparse.
*
* <p>This class is just the error handler for xparse.</p>
*

2
java/src/org/apache/xml/resolver/apps/package.html
View File

@ -3,7 +3,7 @@
<title>Apache XML Commons Resolver Applications package</title>
</head>
<body>
<p>Apache XML Commons Resolver Applications package</p>
<p>Apache XML Commons Resolver Applications package.</p>
<p>This package provides a few simple command-line tools for exploring
the facilities of the resolver.</p>

2
java/src/org/apache/xml/resolver/apps/resolver.java
View File

@ -77,7 +77,7 @@ import org.apache.xml.resolver.helpers.Debug;
import org.apache.xml.resolver.tools.CatalogResolver;
/**
* <p>A simple command-line resolver.</p>
* A simple command-line resolver.
*
* <p>This class implements a simple command-line resolver. It takes
* some parameters and passes them through the resolver, printing the

2
java/src/org/apache/xml/resolver/apps/xparse.java
View File

@ -75,7 +75,7 @@ import org.apache.xml.resolver.CatalogManager;
import org.apache.xml.resolver.helpers.Debug;
/**
* <p>A simple command-line XML parsing application.</p>
* A simple command-line XML parsing application.
*
* <p>This class implements a simple command-line XML Parser. It's
* just a little wrapper around the JAXP Parser with support for

2
java/src/org/apache/xml/resolver/apps/xread.java
View File

@ -75,7 +75,7 @@ import org.apache.xml.resolver.CatalogManager;
import org.apache.xml.resolver.helpers.Debug;
/**
* <p>A simple command-line XML parsing application.</p>
* A simple command-line XML parsing application.
*
* <p>This class implements a simple command-line XML Parser. It's
* just a little wrapper around the JAXP XMLReader with support for

8
java/src/org/apache/xml/resolver/helpers/Debug.java
View File

@ -60,7 +60,7 @@
package org.apache.xml.resolver.helpers;
/**
* <p>Static debugging/messaging class for Catalogs.</p>
* Static debugging/messaging class for Catalogs.
*
* <p>This class defines a set of static methods that can be called
* to produce debugging messages. Messages have an associated "debug
@ -91,7 +91,7 @@ public class Debug {
}
/**
* <p>Print debug message (if the debug level is high enough).</p>
* Print debug message (if the debug level is high enough).
*
* <p>Prints "the message"</p>
*
@ -108,7 +108,7 @@ public class Debug {
}
/**
* <p>Print debug message (if the debug level is high enough).</p>
* Print debug message (if the debug level is high enough).
*
* <p>Prints "the message: spec"</p>
*
@ -126,7 +126,7 @@ public class Debug {
}
/**
* <p>Print debug message (if the debug level is high enough).</p>
* Print debug message (if the debug level is high enough).
*
* <p>Prints "the message: spec1" and "spec2" indented on the next line.</p>
*

18
java/src/org/apache/xml/resolver/helpers/Namespaces.java
View File

@ -62,7 +62,7 @@ package org.apache.xml.resolver.helpers;
import org.w3c.dom.*;
/**
* <p>Static Namespace query methods.</p>
* Static Namespace query methods.
*
* <p>This class defines a set of static methods that can be called
* to analyze the namespace properties of DOM nodes.</p>
@ -74,8 +74,8 @@ import org.w3c.dom.*;
*/
public class Namespaces {
/**
* <p>Returns the "prefix" part of a QName or the empty string (not
* null) if the name has no prefix.</p>
* Returns the "prefix" part of a QName or the empty string (not
* null) if the name has no prefix.
*
* @param element The QName of an element.
* @return The prefix part of the element name.
@ -92,8 +92,8 @@ public class Namespaces {
}
/**
* <p>Returns the "localname" part of a QName, which is the whole
* name if it has no prefix.</p>
* Returns the "localname" part of a QName, which is the whole
* name if it has no prefix.
*
* @param element The QName of an element.
* @return The local part of a QName.
@ -109,8 +109,8 @@ public class Namespaces {
}
/**
* <p>Returns the namespace URI for the specified prefix at the
* specified context node.</p>
* Returns the namespace URI for the specified prefix at the
* specified context node.
*
* @param node The context node.
* @param prefix The prefix.
@ -137,8 +137,8 @@ public class Namespaces {
}
/**
* <p>Returns the namespace URI for the namespace to which the
* element belongs.</p>
* Returns the namespace URI for the namespace to which the
* element belongs.
*
* @param element The element.
* @return The namespace URI associated with the namespace of the

10
java/src/org/apache/xml/resolver/helpers/PublicId.java
View File

@ -60,7 +60,7 @@
package org.apache.xml.resolver.helpers;
/**
* <p>Static methods for dealing with public identifiers.</p>
* Static methods for dealing with public identifiers.
*
* <p>This class defines a set of static methods that can be called
* to handle public identifiers.</p>
@ -74,7 +74,7 @@ public abstract class PublicId {
protected PublicId() { }
/**
* <p>Normalize a public identifier.</p>
* Normalize a public identifier.
*
* <p>Public identifiers must be normalized according to the following
* rules before comparisons between them can be made:</p>
@ -110,7 +110,7 @@ public abstract class PublicId {
}
/**
* <p>Encode a public identifier as a "publicid" URN.</p>
* Encode a public identifier as a "publicid" URN.
*
* <p>This method is declared static so that other classes
* can use it directly.</p>
@ -138,7 +138,7 @@ public abstract class PublicId {
}
/**
* <p>Decode a "publicid" URN into a public identifier.</p>
* Decode a "publicid" URN into a public identifier.
*
* <p>This method is declared static so that other classes
* can use it directly.</p>
@ -172,7 +172,7 @@ public abstract class PublicId {
}
/**
* <p>Replace one string with another.</p>
* Replace one string with another.
*
*/
private static String stringReplace(String str,

2
java/src/org/apache/xml/resolver/helpers/package.html
View File

@ -3,7 +3,7 @@
<title>Apache XML Commons Resolver Helpers package</title>
</head>
<body>
<p>Apache XML Commons Resolver Helpers package</p>
<p>Apache XML Commons Resolver Helpers package.</p>
<p>This package provides a collection of static helper functions used
across a number of different classes.</p>

2
java/src/org/apache/xml/resolver/package.html
View File

@ -3,7 +3,7 @@
<title>Apache XML Commons Resolver package</title>
</head>
<body>
<p>Apache XML Commons Resolver package</p>
<p>Apache XML Commons Resolver package.</p>
<p>The classes in this package implement the full semantics of
<a href="http://www.oasis-open.org/html/a401.htm">OASIS Technical

6
java/src/org/apache/xml/resolver/readers/CatalogReader.java
View File

@ -67,7 +67,7 @@ import java.io.InputStream;
import org.apache.xml.resolver.Catalog;
/**
* <p>The CatalogReader interface.</p>
* The CatalogReader interface.
*
* <p>The Catalog class requires that classes implement this interface
* in order to be used to read catalogs. Examples of CatalogReaders
@ -83,7 +83,7 @@ import org.apache.xml.resolver.Catalog;
*/
public interface CatalogReader {
/**
* <p>Read a catalog from a file</p>
* Read a catalog from a file.
*
* <p>This class reads a catalog from a URL.</p>
*
@ -101,7 +101,7 @@ public interface CatalogReader {
throws MalformedURLException, IOException, CatalogException;
/**
* <p>Read a catalog from an input stream</p>
* Read a catalog from an input stream.
*
* <p>This class reads a catalog from an input stream.</p>
*

4
java/src/org/apache/xml/resolver/readers/DOMCatalogParser.java
View File

@ -63,7 +63,7 @@ import org.apache.xml.resolver.Catalog;
import org.w3c.dom.Node;
/**
* <p>The DOMCatalogParser interface.</p>
* The DOMCatalogParser interface.
*
* <p>This interface must be implemented in order for a class to
* participate as a parser for the DOMCatalogReader.
@ -78,7 +78,7 @@ import org.w3c.dom.Node;
*/
public interface DOMCatalogParser {
/**
* <p>Parse a DOM node as a catalog entry</p>
* Parse a DOM node as a catalog entry.
*
* <p>This method is expected to analyze the specified node and
* construct appropriate catalog entry(ies) from it.</p>

14
java/src/org/apache/xml/resolver/readers/DOMCatalogReader.java
View File

@ -79,7 +79,7 @@ import org.xml.sax.SAXException;
import org.w3c.dom.*;
/**
* <p>A DOM-based CatalogReader</p>
* A DOM-based CatalogReader.
*
* <p>This class is used to read XML Catalogs using the DOM. This reader
* has an advantage over the SAX-based reader that it can analyze the
@ -111,7 +111,7 @@ import org.w3c.dom.*;
*/
public class DOMCatalogReader implements CatalogReader {
/**
* <p>Mapping table from QNames to CatalogParser classes.</p>
* Mapping table from QNames to CatalogParser classes.
*
* <p>Each key in this hash table has the form "elementname"
* or "{namespaceuri}elementname". The former is used if the
@ -120,7 +120,7 @@ public class DOMCatalogReader implements CatalogReader {
protected Hashtable namespaceMap = new Hashtable();
/**
* <p>Add a new parser to the reader.</p>
* Add a new parser to the reader.
*
* <p>This method associates the specified parserClass with the
* namespaceURI/rootElement names specified.</p>
@ -141,7 +141,7 @@ public class DOMCatalogReader implements CatalogReader {
}
/**
* <p>Get the name of the parser class for a given catalog type.</p>
* Get the name of the parser class for a given catalog type.
*
* <p>This method returns the parserClass associated with the
* namespaceURI/rootElement names specified.</p>
@ -160,12 +160,12 @@ public class DOMCatalogReader implements CatalogReader {
}
/**
* <p>Null constructor; something for subclasses to call.</p>
* Null constructor; something for subclasses to call.
*/
public DOMCatalogReader() { }
/**
* <p>Read a catalog from an input stream</p>
* Read a catalog from an input stream.
*
* <p>This class reads a catalog from an input stream:</p>
*
@ -259,7 +259,7 @@ public class DOMCatalogReader implements CatalogReader {
}
/**
* <p>Read the catalog behind the specified URL.</p>
* Read the catalog behind the specified URL.
*
* @see #readCatalog(Catalog, InputStream)
*

10
java/src/org/apache/xml/resolver/readers/ExtendedXMLCatalogReader.java
View File

@ -69,8 +69,8 @@ import org.xml.sax.*;
import org.w3c.dom.*;
/**
* <p>Parse Extended OASIS Entity Resolution Technical Committee
* XML Catalog files.</p>
* Parse Extended OASIS Entity Resolution Technical Committee
* XML Catalog files.
*
* @see Catalog
*
@ -84,9 +84,9 @@ public class ExtendedXMLCatalogReader extends OASISXMLCatalogReader {
public static final String extendedNamespaceName = "http://nwalsh.com/xcatalog/1.0";
/**
* <p>The SAX <code>startElement</code> method recognizes elements
* The SAX <code>startElement</code> method recognizes elements
* from the plain catalog format and instantiates CatalogEntry
* objects for them.</p>
* objects for them.
*
* @param namespaceURI The namespace name of the element.
* @param localName The local name of the element.
@ -180,7 +180,7 @@ public class ExtendedXMLCatalogReader extends OASISXMLCatalogReader {
}
}
/** <p>The SAX <code>endElement</code> method does nothing.</p> */
/** The SAX <code>endElement</code> method does nothing. */
public void endElement (String namespaceURI,
String localName,
String qName)

32
java/src/org/apache/xml/resolver/readers/OASISXMLCatalogReader.java
View File

@ -71,8 +71,8 @@ import org.xml.sax.*;
import org.w3c.dom.*;
/**
* <p>Parse OASIS Entity Resolution Technical Committee
* XML Catalog files.</p>
* Parse OASIS Entity Resolution Technical Committee
* XML Catalog files.
*
* @see Catalog
*
@ -109,9 +109,9 @@ public class OASISXMLCatalogReader extends SAXCatalogReader implements SAXCatalo
}
/**
* <p>Are we in an extension namespace?</p>
* Are we in an extension namespace?
*
* @returns true if the current stack of open namespaces includes
* @return true if the current stack of open namespaces includes
* an extension namespace.
*/
protected boolean inExtensionNamespace() {
@ -134,12 +134,12 @@ public class OASISXMLCatalogReader extends SAXCatalogReader implements SAXCatalo
// ----------------------------------------------------------------------
// Implement the SAX ContentHandler interface
/** <p>The SAX <code>setDocumentLocator</code> method does nothing.</p> */
/** The SAX <code>setDocumentLocator</code> method does nothing. */
public void setDocumentLocator (Locator locator) {
return;
}
/** <p>The SAX <code>startDocument</code> method does nothing.</p> */
/** The SAX <code>startDocument</code> method does nothing. */
public void startDocument ()
throws SAXException {
baseURIStack.push(catalog.getCurrentBase());
@ -147,16 +147,16 @@ public class OASISXMLCatalogReader extends SAXCatalogReader implements SAXCatalo
return;
}
/** <p>The SAX <code>endDocument</code> method does nothing.</p> */
/** The SAX <code>endDocument</code> method does nothing. */
public void endDocument ()
throws SAXException {
return;
}
/**
* <p>The SAX <code>startElement</code> method recognizes elements
* The SAX <code>startElement</code> method recognizes elements
* from the plain catalog format and instantiates CatalogEntry
* objects for them.</p>
* objects for them.
*
* @param namespaceURI The namespace name of the element.
* @param localName The local name of the element.
@ -449,7 +449,7 @@ public class OASISXMLCatalogReader extends SAXCatalogReader implements SAXCatalo
&& checkAttributes(atts, attName2);
}
/** <p>The SAX <code>endElement</code> method does nothing.</p> */
/** The SAX <code>endElement</code> method does nothing. */
public void endElement (String namespaceURI,
String localName,
String qName)
@ -519,37 +519,37 @@ public class OASISXMLCatalogReader extends SAXCatalogReader implements SAXCatalo
return;
}
/** <p>The SAX <code>characters</code> method does nothing.</p> */
/** The SAX <code>characters</code> method does nothing. */
public void characters (char ch[], int start, int length)
throws SAXException {
return;
}
/** <p>The SAX <code>ignorableWhitespace</code> method does nothing.</p> */
/** The SAX <code>ignorableWhitespace</code> method does nothing. */
public void ignorableWhitespace (char ch[], int start, int length)
throws SAXException {
return;
}
/** <p>The SAX <code>processingInstruction</code> method does nothing.</p> */
/** The SAX <code>processingInstruction</code> method does nothing. */
public void processingInstruction (String target, String data)
throws SAXException {
return;
}
/** <p>The SAX <code>skippedEntity</code> method does nothing.</p> */
/** The SAX <code>skippedEntity</code> method does nothing. */
public void skippedEntity (String name)
throws SAXException {
return;
}
/** <p>The SAX <code>startPrefixMapping</code> method does nothing.</p> */
/** The SAX <code>startPrefixMapping</code> method does nothing. */
public void startPrefixMapping(String prefix, String uri)
throws SAXException {
return;
}
/** <p>The SAX <code>endPrefixMapping</code> method does nothing.</p> */
/** The SAX <code>endPrefixMapping</code> method does nothing. */
public void endPrefixMapping(String prefix)
throws SAXException {
return;

2
java/src/org/apache/xml/resolver/readers/SAXCatalogParser.java
View File

@ -63,7 +63,7 @@ import org.apache.xml.resolver.Catalog;
import org.xml.sax.*;
/**
* <p>The SAXCatalogParser interface.</p>
* The SAXCatalogParser interface.
*
* <p>This interface must be implemented in order for a class to
* participate as a parser for the SAXCatalogReader.

34
java/src/org/apache/xml/resolver/readers/SAXCatalogReader.java
View File

@ -78,7 +78,7 @@ import org.xml.sax.*;
import javax.xml.parsers.*;
/**
* <p>A SAX-based CatalogReader</p>
* A SAX-based CatalogReader.
*
* <p>This class is used to read XML Catalogs using the SAX. This reader
* has an advantage over the DOM-based reader in that it functions on
@ -113,7 +113,7 @@ public class SAXCatalogReader implements CatalogReader, ContentHandler, Document
protected String parserClass = null;
/**
* <p>Mapping table from QNames to CatalogParser classes.</p>
* Mapping table from QNames to CatalogParser classes.
*
* <p>Each key in this hash table has the form "elementname"
* or "{namespaceuri}elementname". The former is used if the
@ -207,7 +207,7 @@ public class SAXCatalogReader implements CatalogReader, ContentHandler, Document
}
/**
* <p>Parse an XML Catalog file.</p>
* Parse an XML Catalog file.
*
* @param catalog The catalog to which this catalog file belongs
* @param fileUrl The URL or filename of the catalog file to process
@ -239,7 +239,7 @@ public class SAXCatalogReader implements CatalogReader, ContentHandler, Document
}
/**
* <p>Parse an XML Catalog stream.</p>
* Parse an XML Catalog stream.
*
* @param catalog The catalog to which this catalog file belongs
* @param is The input stream from which the catalog will be read
@ -301,21 +301,21 @@ public class SAXCatalogReader implements CatalogReader, ContentHandler, Document
// ----------------------------------------------------------------------
// Implement the SAX ContentHandler interface
/** <p>The SAX <code>setDocumentLocator</code> method. Does nothing.</p> */
/** The SAX <code>setDocumentLocator</code> method. Does nothing. */
public void setDocumentLocator (Locator locator) {
if (saxParser != null) {
saxParser.setDocumentLocator(locator);
}
}
/** <p>The SAX <code>startDocument</code> method. Does nothing.</p> */
/** The SAX <code>startDocument</code> method. Does nothing. */
public void startDocument () throws SAXException {
saxParser = null;
abandonHope = false;
return;
}
/** <p>The SAX <code>endDocument</code> method. Does nothing.</p> */
/** The SAX <code>endDocument</code> method. Does nothing. */
public void endDocument ()throws SAXException {
if (saxParser != null) {
saxParser.endDocument();
@ -323,7 +323,7 @@ public class SAXCatalogReader implements CatalogReader, ContentHandler, Document
}
/**
* <p>The SAX <code>startElement</code> method.</p>
* The SAX <code>startElement</code> method.
*
* <p>The catalog parser is selected based on the namespace of the
* first element encountered in the catalog.</p>
@ -399,7 +399,7 @@ public class SAXCatalogReader implements CatalogReader, ContentHandler, Document
}
/**
* <p>The SAX2 <code>startElement</code> method.</p>
* The SAX2 <code>startElement</code> method.
*
* <p>The catalog parser is selected based on the namespace of the
* first element encountered in the catalog.</p>
@ -459,14 +459,14 @@ public class SAXCatalogReader implements CatalogReader, ContentHandler, Document
}
}
/** <p>The SAX <code>endElement</code> method. Does nothing.</p> */
/** The SAX <code>endElement</code> method. Does nothing. */
public void endElement (String name) throws SAXException {
if (saxParser != null) {
saxParser.endElement(name);
}
}
/** <p>The SAX2 <code>endElement</code> method. Does nothing.</p> */
/** The SAX2 <code>endElement</code> method. Does nothing. */
public void endElement (String namespaceURI,
String localName,
String qName) throws SAXException {
@ -475,7 +475,7 @@ public class SAXCatalogReader implements CatalogReader, ContentHandler, Document
}
}
/** <p>The SAX <code>characters</code> method. Does nothing.</p> */
/** The SAX <code>characters</code> method. Does nothing. */
public void characters (char ch[], int start, int length)
throws SAXException {
if (saxParser != null) {
@ -483,7 +483,7 @@ public class SAXCatalogReader implements CatalogReader, ContentHandler, Document
}
}
/** <p>The SAX <code>ignorableWhitespace</code> method. Does nothing.</p> */
/** The SAX <code>ignorableWhitespace</code> method. Does nothing. */
public void ignorableWhitespace (char ch[], int start, int length)
throws SAXException {
if (saxParser != null) {
@ -491,7 +491,7 @@ public class SAXCatalogReader implements CatalogReader, ContentHandler, Document
}
}
/** <p>The SAX <code>processingInstruction</code> method. Does nothing.</p> */
/** The SAX <code>processingInstruction</code> method. Does nothing. */
public void processingInstruction (String target, String data)
throws SAXException {
if (saxParser != null) {
@ -499,7 +499,7 @@ public class SAXCatalogReader implements CatalogReader, ContentHandler, Document
}
}
/** <p>The SAX <code>startPrefixMapping</code> method. Does nothing.</p> */
/** The SAX <code>startPrefixMapping</code> method. Does nothing. */
public void startPrefixMapping (String prefix, String uri)
throws SAXException {
if (saxParser != null) {
@ -507,7 +507,7 @@ public class SAXCatalogReader implements CatalogReader, ContentHandler, Document
}
}
/** <p>The SAX <code>endPrefixMapping</code> method. Does nothing.</p> */
/** The SAX <code>endPrefixMapping</code> method. Does nothing. */
public void endPrefixMapping (String prefix)
throws SAXException {
if (saxParser != null) {
@ -515,7 +515,7 @@ public class SAXCatalogReader implements CatalogReader, ContentHandler, Document
}
}
/** <p>The SAX <code>skippedentity</code> method. Does nothing.</p> */
/** The SAX <code>skippedentity</code> method. Does nothing. */
public void skippedEntity (String name)
throws SAXException {
if (saxParser != null) {

2
java/src/org/apache/xml/resolver/readers/SAXParserHandler.java
View File

@ -65,7 +65,7 @@ import org.xml.sax.*;
import org.xml.sax.helpers.*;
/**
* <p>An entity-resolving DefaultHandler</p>
* An entity-resolving DefaultHandler.
*
* <p>This class provides a SAXParser DefaultHandler that performs
* entity resolution.

6
java/src/org/apache/xml/resolver/readers/TR9401CatalogReader.java
View File

@ -68,7 +68,7 @@ import org.apache.xml.resolver.CatalogEntry;
import org.apache.xml.resolver.CatalogException;
/**
* <p>Parses OASIS Open Catalog files.</p>
* Parses OASIS Open Catalog files.
*
* <p>This class reads OASIS Open Catalog files, returning a stream
* of tokens.</p>
@ -91,9 +91,9 @@ import org.apache.xml.resolver.CatalogException;
public class TR9401CatalogReader extends TextCatalogReader {
/**
* <p>Start parsing an OASIS TR9401 Open Catalog file. The file is
* Start parsing an OASIS TR9401 Open Catalog file. The file is
* actually read and parsed
* as needed by <code>nextEntry</code>.</p>
* as needed by <code>nextEntry</code>.
*
* <p>In a TR9401 Catalog the 'DELEGATE' entry delegates public
* identifiers. There is no delegate entry for system identifiers

12
java/src/org/apache/xml/resolver/readers/TextCatalogReader.java
View File

@ -73,7 +73,7 @@ import org.apache.xml.resolver.CatalogException;
import org.apache.xml.resolver.readers.CatalogReader;
/**
* <p>Parses plain text Catalog files.</p>
* Parses plain text Catalog files.
*
* <p>This class reads plain text Open Catalog files.</p>
*
@ -107,7 +107,7 @@ public class TextCatalogReader implements CatalogReader {
protected boolean caseSensitive = false;
/**
* <p>Construct a CatalogReader object.</p>
* Construct a CatalogReader object.
*/
public TextCatalogReader() { }
@ -120,7 +120,7 @@ public class TextCatalogReader implements CatalogReader {
}
/**
* <p>Start parsing a text catalog file. The file is
* Start parsing a text catalog file. The file is
* actually read and parsed
* as needed by <code>nextEntry</code>.</p>
*
@ -209,7 +209,7 @@ public class TextCatalogReader implements CatalogReader {
}
/**
* <p>The destructor.</p>
* The destructor.
*
* <p>Makes sure the catalog file is closed.</p>
*/
@ -227,7 +227,7 @@ public class TextCatalogReader implements CatalogReader {
// -----------------------------------------------------------------
/**
* <p>Return the next token in the catalog file.</p>
* Return the next token in the catalog file.
*
* @return The Catalog file token from the input stream.
* @throws IOException If an error occurs reading from the stream.
@ -307,7 +307,7 @@ public class TextCatalogReader implements CatalogReader {
}
/**
* <p>Return the next logical character from the input stream.</p>
* Return the next logical character from the input stream.
*
* @return The next (logical) character from the input stream. The
* character may be buffered from a previous lookahead.

22
java/src/org/apache/xml/resolver/readers/XCatalogReader.java
View File

@ -70,8 +70,8 @@ import org.xml.sax.*;
import javax.xml.parsers.*;
/**
* <p>Parse "xcatalog" XML Catalog files, this is the XML Catalog format
* developed by John Cowan and supported by Apache.</p>
* Parse "xcatalog" XML Catalog files, this is the XML Catalog format
* developed by John Cowan and supported by Apache.
*
* @see Catalog
*
@ -104,27 +104,27 @@ public class XCatalogReader extends SAXCatalogReader implements SAXCatalogParser
// ----------------------------------------------------------------------
// Implement the SAX DocumentHandler interface
/** <p>The SAX <code>setDocumentLocator</code> method does nothing.</p> */
/** The SAX <code>setDocumentLocator</code> method does nothing. */
public void setDocumentLocator (Locator locator) {
return;
}
/** <p>The SAX <code>startDocument</code> method does nothing.</p> */
/** The SAX <code>startDocument</code> method does nothing. */
public void startDocument ()
throws SAXException {
return;
}
/** <p>The SAX <code>endDocument</code> method does nothing.</p> */
/** The SAX <code>endDocument</code> method does nothing. */
public void endDocument ()
throws SAXException {
return;
}
/**
* <p>The SAX <code>startElement</code> method recognizes elements
* The SAX <code>startElement</code> method recognizes elements
* from the plain catalog format and instantiates CatalogEntry
* objects for them.</p>
* objects for them.
*
* @param namespaceURI The namespace name of the element.
* @param localName The local name of the element.
@ -197,7 +197,7 @@ public class XCatalogReader extends SAXCatalogReader implements SAXCatalogParser
}
}
/** <p>The SAX <code>endElement</code> method does nothing.</p> */
/** The SAX <code>endElement</code> method does nothing. */
public void endElement (String namespaceURI,
String localName,
String qName)
@ -205,19 +205,19 @@ public class XCatalogReader extends SAXCatalogReader implements SAXCatalogParser
return;
}
/** <p>The SAX <code>characters</code> method does nothing.</p> */
/** The SAX <code>characters</code> method does nothing. */
public void characters (char ch[], int start, int length)
throws SAXException {
return;
}
/** <p>The SAX <code>ignorableWhitespace</code> method does nothing.</p> */
/** The SAX <code>ignorableWhitespace</code> method does nothing. */
public void ignorableWhitespace (char ch[], int start, int length)
throws SAXException {
return;
}
/** <p>The SAX <code>processingInstruction</code> method does nothing.</p> */
/** The SAX <code>processingInstruction</code> method does nothing. */
public void processingInstruction (String target, String data)
throws SAXException {
return;

2
java/src/org/apache/xml/resolver/readers/package.html
View File

@ -3,7 +3,7 @@
<title>Apache XML Commons Resolver Readers package</title>
</head>
<body>
<p>Apache XML Commons Resolver Readers package</p>
<p>Apache XML Commons Resolver Readers package.</p>
<p>This package provides the set of classes that read catalog files
and extract catalog entries from them.</p>

10
java/src/org/apache/xml/resolver/tools/CatalogResolver.java
View File

@ -75,7 +75,7 @@ import org.apache.xml.resolver.Catalog;
import org.apache.xml.resolver.CatalogManager;
/**
* <p>A SAX EntityResolver/JAXP URIResolver that uses catalogs.</p>
* A SAX EntityResolver/JAXP URIResolver that uses catalogs.
*
* <p>This class implements both a SAX EntityResolver and a JAXP URIResolver.
* </p>
@ -133,8 +133,8 @@ public class CatalogResolver implements EntityResolver, URIResolver {
}
/**
* <p>Implements the guts of the <code>resolveEntity</code> method
* for the SAX interface.</p>
* Implements the guts of the <code>resolveEntity</code> method
* for the SAX interface.
*
* <p>Presented with an optional public identifier and a system
* identifier, this function attempts to locate a mapping in the
@ -196,8 +196,8 @@ public class CatalogResolver implements EntityResolver, URIResolver {
}
/**
* <p>Implements the <code>resolveEntity</code> method
* for the SAX interface.</p>
* Implements the <code>resolveEntity</code> method
* for the SAX interface.
*
* <p>Presented with an optional public identifier and a system
* identifier, this function attempts to locate a mapping in the

66
java/src/org/apache/xml/resolver/tools/ResolvingParser.java
View File

@ -73,7 +73,7 @@ import org.apache.xml.resolver.Catalog;
import org.apache.xml.resolver.CatalogManager;
/**
* <p>A SAX Parser that performs catalog-based entity resolution.</p>
* A SAX Parser that performs catalog-based entity resolution.
*
* <p>This class implements a SAX Parser that performs entity resolution
* using the CatalogResolver. The actual, underlying parser is obtained
@ -104,25 +104,25 @@ public class ResolvingParser
*/
public static boolean suppressExplanation = false;
/** The underlying parser */
/** The underlying parser. */
private SAXParser saxParser = null;
/** The underlying reader */
/** The underlying reader. */
private Parser parser = null;
/** The underlying DocumentHandler */
/** The underlying DocumentHandler. */
private DocumentHandler documentHandler = null;
/** The underlying DTDHandler */
/** The underlying DTDHandler. */
private DTDHandler dtdHandler = null;
/** The manager for the underlying resolver */
/** The manager for the underlying resolver. */
private CatalogManager catalogManager = CatalogManager.getStaticManager();
/** The underlying catalog resolver */
/** The underlying catalog resolver. */
private CatalogResolver catalogResolver = null;
/** A separate resolver for oasis-xml-pi catalogs */
/** A separate resolver for oasis-xml-pi catalogs. */
private CatalogResolver piCatalogResolver = null;
/** Are we in the prolog? Is an oasis-xml-catalog PI valid now? */
@ -134,18 +134,18 @@ public class ResolvingParser
/** The base URI of the input document, if known. */
private URL baseURL = null;
/** Constructor */
/** Constructor. */
public ResolvingParser() {
initParser();
}
/** Constructor */
/** Constructor. */
public ResolvingParser(CatalogManager manager) {
catalogManager = manager;
initParser();
}
/** Initialize the parser */
/** Initialize the parser. */
private void initParser() {
catalogResolver = new CatalogResolver(catalogManager);
@ -163,13 +163,13 @@ public class ResolvingParser
}
}
/** Return the Catalog being used */
/** Return the Catalog being used. */
public Catalog getCatalog() {
return catalogResolver.getCatalog();
}
/**
* <p>SAX Parser API</p>
* SAX Parser API.
*
* <p>Note that the JAXP 1.1ea2 parser crashes with an InternalError if
* it encounters a system identifier that appears to be a relative URI
@ -201,7 +201,7 @@ public class ResolvingParser
}
}
/** SAX Parser API
/** SAX Parser API.
*
* @see #parse(InputSource)
*/
@ -217,18 +217,18 @@ public class ResolvingParser
}
}
/** SAX Parser API */
/** SAX Parser API. */
public void setDocumentHandler(DocumentHandler handler) {
documentHandler = handler;
}
/** SAX Parser API */
/** SAX Parser API. */
public void setDTDHandler(DTDHandler handler) {
dtdHandler = handler;
}
/**
* <p>SAX Parser API</p>
* SAX Parser API.
*
* <p>The purpose of this class is to implement an entity resolver.
* Attempting to set a different one is pointless (and ignored).</p>
@ -237,17 +237,17 @@ public class ResolvingParser
// nop
}
/** SAX Parser API */
/** SAX Parser API. */
public void setErrorHandler(ErrorHandler handler) {
parser.setErrorHandler(handler);
}
/** SAX Parser API */
/** SAX Parser API. */
public void setLocale(Locale locale) throws SAXException {
parser.setLocale(locale);
}
/** SAX DocumentHandler API */
/** SAX DocumentHandler API. */
public void characters(char[] ch, int start, int length)
throws SAXException {
if (documentHandler != null) {
@ -255,21 +255,21 @@ public class ResolvingParser
}
}
/** SAX DocumentHandler API */
/** SAX DocumentHandler API. */
public void endDocument() throws SAXException {
if (documentHandler != null) {
documentHandler.endDocument();
}
}
/** SAX DocumentHandler API */
/** SAX DocumentHandler API. */
public void endElement(String name) throws SAXException {
if (documentHandler != null) {
documentHandler.endElement(name);
}
}
/** SAX DocumentHandler API */
/** SAX DocumentHandler API. */
public void ignorableWhitespace(char[] ch, int start, int length)
throws SAXException {
if (documentHandler != null) {
@ -277,7 +277,7 @@ public class ResolvingParser
}
}
/** SAX DocumentHandler API */
/** SAX DocumentHandler API. */
public void processingInstruction(String target, String pidata)
throws SAXException {
@ -342,21 +342,21 @@ public class ResolvingParser
}
}
/** SAX DocumentHandler API */
/** SAX DocumentHandler API. */
public void setDocumentLocator(Locator locator) {
if (documentHandler != null) {
documentHandler.setDocumentLocator(locator);
}
}
/** SAX DocumentHandler API */
/** SAX DocumentHandler API. */
public void startDocument() throws SAXException {
if (documentHandler != null) {
documentHandler.startDocument();
}
}
/** SAX DocumentHandler API */
/** SAX DocumentHandler API. */
public void startElement(String name, AttributeList atts)
throws SAXException {
allowXMLCatalogPI = false;
@ -365,7 +365,7 @@ public class ResolvingParser
}
}
/** SAX DTDHandler API */
/** SAX DTDHandler API. */
public void notationDecl (String name, String publicId, String systemId)
throws SAXException {
allowXMLCatalogPI = false;
@ -374,7 +374,7 @@ public class ResolvingParser
}
}
/** SAX DTDHandler API */
/** SAX DTDHandler API. */
public void unparsedEntityDecl (String name,
String publicId,
String systemId,
@ -387,9 +387,9 @@ public class ResolvingParser
}
/**
* <p>Implements the <code>resolveEntity</code> method
* Implements the <code>resolveEntity</code> method
* for the SAX interface, using an underlying CatalogResolver
* to do the real work.</p>
* to do the real work.
*/
public InputSource resolveEntity (String publicId, String systemId) {
allowXMLCatalogPI = false;
@ -429,7 +429,7 @@ public class ResolvingParser
}
}
/** Setup for parsing */
/** Setup for parsing. */
private void setupParse(String systemId) {
allowXMLCatalogPI = true;
parser.setEntityResolver(this);
@ -463,7 +463,7 @@ public class ResolvingParser
}
}
/** Provide one possible explanation for an InternalError */
/** Provide one possible explanation for an InternalError. */
private void explain(String systemId) {
if (!suppressExplanation) {
System.out.println("Parser probably encountered bad URI in " + systemId);

39
java/src/org/apache/xml/resolver/tools/ResolvingXMLFilter.java
View File

@ -73,7 +73,7 @@ import org.apache.xml.resolver.Catalog;
import org.apache.xml.resolver.CatalogManager;
/**
* <p>A SAX XMLFilter that performs catalog-based entity resolution.</p>
* A SAX XMLFilter that performs catalog-based entity resolution.
*
* <p>This class implements a SAX XMLFilter that performs entity resolution
* using the CatalogResolver. The actual, underlying parser is obtained
@ -89,19 +89,20 @@ import org.apache.xml.resolver.CatalogManager;
* @version 1.0
*/
public class ResolvingXMLFilter extends XMLFilterImpl {
/** Suppress explanatory message?
/**
* Suppress explanatory message?
*
* @see #parse(InputSource)
*/
public static boolean suppressExplanation = false;
/** The manager for the underlying resolver */
/** The manager for the underlying resolver. */
private CatalogManager catalogManager = CatalogManager.getStaticManager();
/** The underlying catalog resolver */
/** The underlying catalog resolver. */
private CatalogResolver catalogResolver = null;
/** A separate resolver for oasis-xml-pi catalogs */
/** A separate resolver for oasis-xml-pi catalogs. */
private CatalogResolver piCatalogResolver = null;
/** Are we in the prolog? Is an oasis-xml-catalog PI valid now? */
@ -113,26 +114,26 @@ public class ResolvingXMLFilter extends XMLFilterImpl {
/** The base URI of the input document, if known. */
private URL baseURL = null;
/** Construct an empty XML Filter with no parent */
/** Construct an empty XML Filter with no parent. */
public ResolvingXMLFilter() {
super();
catalogResolver = new CatalogResolver(catalogManager);
}
/** Construct an XML filter with the specified parent */
/** Construct an XML filter with the specified parent. */
public ResolvingXMLFilter(XMLReader parent) {
super(parent);
catalogResolver = new CatalogResolver(catalogManager);
}
/** Construct an XML filter with the specified parent */
/** Construct an XML filter with the specified parent. */
public ResolvingXMLFilter(CatalogManager manager) {
super();
catalogManager = manager;
catalogResolver = new CatalogResolver(catalogManager);
}
/** Construct an XML filter with the specified parent */
/** Construct an XML filter with the specified parent. */
public ResolvingXMLFilter(XMLReader parent, CatalogManager manager) {
super(parent);
catalogManager = manager;
@ -140,14 +141,14 @@ public class ResolvingXMLFilter extends XMLFilterImpl {
}
/**
* <p>Provide accessto the underlying Catalog</p>
* Provide accessto the underlying Catalog.
*/
public Catalog getCatalog() {
return catalogResolver.getCatalog();
}
/**
* <p>SAX XMLReader API</p>
* SAX XMLReader API.
*
* <p>Note that the JAXP 1.1ea2 parser crashes with an InternalError if
* it encounters a system identifier that appears to be a relative URI
@ -181,7 +182,7 @@ public class ResolvingXMLFilter extends XMLFilterImpl {
}
}
/** SAX XMLReader API
/** SAX XMLReader API.
*
* @see #parse(InputSource)
*/
@ -200,9 +201,9 @@ public class ResolvingXMLFilter extends XMLFilterImpl {
}
/**
* <p>Implements the <code>resolveEntity</code> method
* Implements the <code>resolveEntity</code> method
* for the SAX interface, using an underlying CatalogResolver
* to do the real work.</p>
* to do the real work.
*/
public InputSource resolveEntity (String publicId, String systemId) {
allowXMLCatalogPI = false;
@ -242,7 +243,7 @@ public class ResolvingXMLFilter extends XMLFilterImpl {
}
}
/** SAX DTDHandler API
/** SAX DTDHandler API.
*
* <p>Captured here only to detect the end of the prolog so that
* we can ignore subsequent oasis-xml-catalog PIs. Otherwise
@ -254,7 +255,7 @@ public class ResolvingXMLFilter extends XMLFilterImpl {
super.notationDecl(name,publicId,systemId);
}
/** SAX DTDHandler API
/** SAX DTDHandler API.
*
* <p>Captured here only to detect the end of the prolog so that
* we can ignore subsequent oasis-xml-catalog PIs. Otherwise
@ -269,7 +270,7 @@ public class ResolvingXMLFilter extends XMLFilterImpl {
super.unparsedEntityDecl (name, publicId, systemId, notationName);
}
/** SAX ContentHandler API
/** SAX ContentHandler API.
*
* <p>Captured here only to detect the end of the prolog so that
* we can ignore subsequent oasis-xml-catalog PIs. Otherwise
@ -282,7 +283,7 @@ public class ResolvingXMLFilter extends XMLFilterImpl {
super.startElement(uri,localName,qName,atts);
}
/** SAX ContentHandler API
/** SAX ContentHandler API.
*
* <p>Detect and use the oasis-xml-catalog PI if it occurs.</p>
*/
@ -376,7 +377,7 @@ public class ResolvingXMLFilter extends XMLFilterImpl {
}
}
/** Provide one possible explanation for an InternalError */
/** Provide one possible explanation for an InternalError. */
private void explain(String systemId) {
if (!suppressExplanation) {
System.out.println("XMLReader probably encountered bad URI in " + systemId);

6
java/src/org/apache/xml/resolver/tools/ResolvingXMLReader.java
View File

@ -66,7 +66,7 @@ import javax.xml.parsers.*;
import org.apache.xml.resolver.*;
/**
* <p>A SAX XMLReader that performs catalog-based entity resolution.</p>
* A SAX XMLReader that performs catalog-based entity resolution.
*
* <p>This class implements a SAX XMLReader that performs entity resolution
* using the CatalogResolver. The actual, underlying parser is obtained
@ -83,7 +83,7 @@ import org.apache.xml.resolver.*;
*/
public class ResolvingXMLReader extends ResolvingXMLFilter {
/**
* <p>Construct a new reader from the JAXP factory</p>
* Construct a new reader from the JAXP factory.
*
* <p>In order to do its job, a ResolvingXMLReader must in fact be
* a filter. So the only difference between this code and the filter
@ -101,7 +101,7 @@ public class ResolvingXMLReader extends ResolvingXMLFilter {
}
/**
* <p>Construct a new reader from the JAXP factory</p>
* Construct a new reader from the JAXP factory.
*
* <p>In order to do its job, a ResolvingXMLReader must in fact be
* a filter. So the only difference between this code and the filter

2
java/src/org/apache/xml/resolver/tools/package.html
View File

@ -3,7 +3,7 @@
<title>Apache XML Commons Resolver Tools package</title>
</head>
<body>
<p>Apache XML Commons Resolver Tools package</p>
<p>Apache XML Commons Resolver Tools package.</p>
<p>This package implements several tool classes for catalog-based
entity resolution:</p>