Represents OASIS Open Catalog files.
+ * Represents OASIS Open Catalog files. * *This class implements the semantics of OASIS Open Catalog files * (defined by @@ -220,58 +220,58 @@ import javax.xml.parsers.SAXParserFactory; * Inc.
*/ 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(); /** - *A vector of catalog files to be loaded.
+ * A vector of catalog files to be loaded. * *This list is initially established by
* loadSystemCatalogs when
@@ -306,8 +306,8 @@ public class Catalog {
protected Vector catalogFiles = new Vector();
/**
- *
A vector of catalog files constructed during processing of - * CATALOG entries in the current catalog.
+ * A vector of catalog files constructed during processing of + * CATALOG entries in the current catalog. * *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(); /** - *
A vector of Catalogs.
+ * A vector of Catalogs. * *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(); /** - *
A vector of DELEGATE* Catalog entries constructed during - * processing of the Catalog.
+ * A vector of DELEGATE* Catalog entries constructed during + * processing of the Catalog. * *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(); /** - *
A hash of CatalogReaders.
+ * A hash of CatalogReaders. * *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(); /** - *
A vector of CatalogReaders.
+ * A vector of CatalogReaders. * *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(); /** - *
Constructs an empty Catalog.
+ * Constructs an empty Catalog. * *The constructor interrogates the relevant system properties * using the default (static) CatalogManager @@ -391,7 +391,7 @@ public class Catalog { } /** - *
Constructs an empty Catalog with a specific CatalogManager.
+ * Constructs an empty Catalog with a specific CatalogManager. * *The constructor interrogates the relevant system properties * using the specified Catalog Manager @@ -418,7 +418,7 @@ public class Catalog { } /** - *
Setup readers.
+ * Setup readers. */ public void setupReaders() { SAXParserFactory spf = SAXParserFactory.newInstance(); @@ -441,7 +441,7 @@ public class Catalog { } /** - *Add a new CatalogReader to the Catalog.
+ * Add a new CatalogReader to the Catalog. * *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 { } /** - *
Copies the reader list from the current Catalog to a new Catalog
+ * Copies the reader list from the current Catalog to a new Catalog. * *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 { } /** - *
Create a new Catalog object.
+ * Create a new Catalog object. * *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 { } /** - *
Returns the current base URI.
+ * Returns the current base URI. */ public String getCurrentBase() { return base.toString(); } /** - *Returns the default override setting associated with this - * catalog.
+ * Returns the default override setting associated with this + * catalog. * *All catalog files loaded by this catalog will have the * initial override setting specified by this default.
@@ -566,7 +566,7 @@ public class Catalog { } /** - *Load the system catalog files.
+ * Load the system catalog files. * *The method adds all of the * catalogs specified in the xml.catalog.files property @@ -605,7 +605,7 @@ public class Catalog { } /** - *
Parse a catalog file, augmenting internal data structures
+ * 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 { } /** - *Parse a catalog file, augmenting internal data structures
+ * Parse a catalog file, augmenting internal data structures. * *Catalogs retrieved over the net may have an associated MIME type. * The MIME type can be used to select an appropriate reader.
@@ -667,7 +667,7 @@ public class Catalog { } /** - *Parse a catalog document, augmenting internal data structures
+ * Parse a catalog document, augmenting internal data structures. * *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.
* + *Written by Stefan Wachter (2002-09-26)
+ * * @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 { } /** - *Parse all of the pending catalogs.
+ * Parse all of the pending catalogs. * *Catalogs may refer to other catalogs, this method parses * all of the currently pending catalog files.
@@ -819,7 +820,7 @@ public class Catalog { } /** - *Parse a single catalog file, augmenting internal data structures
+ * 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 { } /** - *Cleanup and process a Catalog entry.
+ * Cleanup and process a Catalog entry. * *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 { } /** - *
Handle unknown CatalogEntry types.
+ * Handle unknown CatalogEntry types. * *This method exists to allow subclasses to deal with unknown * entry types.
@@ -1105,7 +1106,7 @@ public class Catalog { } /** - *Parse all subordinate catalogs.
+ * Parse all subordinate catalogs. * *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 { /** - *
Return the applicable DOCTYPE system identifier.
+ * 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 { } /** - *Return the applicable DOCUMENT entry.
+ * Return the applicable DOCUMENT entry. * * @return The system identifier to use for the doctype. * @@ -1280,7 +1281,7 @@ public class Catalog { } /** - *Return the applicable ENTITY system identifier.
+ * 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 { } /** - *Return the applicable NOTATION system identifier.
+ * 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 { } /** - *Return the applicable PUBLIC or SYSTEM identifier.
+ * Return the applicable PUBLIC or SYSTEM identifier. * *This method searches the Catalog and returns the system * identifier specified for the given system or @@ -1521,7 +1522,7 @@ public class Catalog { } /** - *
Return the applicable PUBLIC or SYSTEM identifier
+ * Return the applicable PUBLIC or SYSTEM identifier. * *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 { } /** - *
Return the applicable SYSTEM system identifier
+ * Return the applicable SYSTEM system identifier. * *If a SYSTEM entry exists in the Catalog * for the system ID specified, return the mapped value.
@@ -1698,8 +1699,8 @@ public class Catalog { } /** - *Return the applicable SYSTEM system identifier in this - * catalog.
+ * Return the applicable SYSTEM system identifier in this + * catalog. * *If a SYSTEM entry exists in the catalog file * for the system ID specified, return the mapped value.
@@ -1793,7 +1794,7 @@ public class Catalog { } /** - *Return the applicable URI
+ * Return the applicable URI. * *If a URI entry exists in the Catalog * for the URI specified, return the mapped value.
@@ -1836,8 +1837,7 @@ public class Catalog { } /** - *Return the applicable URI in this - * catalog.
+ * Return the applicable URI in this catalog. * *If a URI entry exists in the catalog file * for the URI specified, return the mapped value.
@@ -1926,8 +1926,7 @@ public class Catalog { } /** - *Search the subordinate catalogs, in order, looking for a - * match.
+ * Search the subordinate catalogs, in order, looking for a match. * *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 { // ----------------------------------------------------------------- /** - *
Replace backslashes with forward slashes. (URLs always use - * forward slashes.)
+ * 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 { } /** - *Construct an absolute URI from a relative one, using the current - * base URI.
+ * 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 { } /** - *Perform character normalization on a URI reference.
+ * Perform character normalization on a URI reference. * * @param uriref The URI reference * @return The normalized URI reference. @@ -2103,7 +2102,7 @@ public class Catalog { } /** - *Perform %-encoding on a single byte.
+ * 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 { // ----------------------------------------------------------------- /** - *Add to the current list of delegated catalogs.
+ * Add to the current list of delegated catalogs. * *This method always constructs the {@link #localDelegate} * vector so that it is ordered by length of partial diff --git a/java/src/org/apache/xml/resolver/CatalogEntry.java b/java/src/org/apache/xml/resolver/CatalogEntry.java index a7340ab..6573c9a 100644 --- a/java/src/org/apache/xml/resolver/CatalogEntry.java +++ b/java/src/org/apache/xml/resolver/CatalogEntry.java @@ -63,7 +63,7 @@ import java.util.Hashtable; import java.util.Vector; /** - *
Represents a Catalog entry.
+ * Represents a Catalog entry. * *Instances of this class represent individual entries * in a Catalog.
@@ -104,7 +104,7 @@ public class CatalogEntry { protected static Vector entryArgs = new Vector(); /** - *Adds a new catalog entry type.
+ * 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 { } /** - *Lookup an entry type
+ * 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 { } /** - *Find out how many arguments an entry is required to have.
+ * 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 { } /** - *Find out how many arguments an entry is required to have.
+ * 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; /** - *Null constructor; something for subclasses to call.
+ * Null constructor; something for subclasses to call. */ public CatalogEntry() {} /** - *Construct a catalog entry of the specified type.
+ * 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 { } /** - *Construct a catalog entry of the specified type.
+ * 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 { } /** - *Get the entry type.
+ * Get the entry type. * * @return The entry type of the CatalogEntry */ @@ -254,7 +254,7 @@ public class CatalogEntry { } /** - *Get an entry argument.
+ * 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 { } /** - *Set an entry argument.
+ * Set an entry argument. * *Catalogs sometimes need to adjust the catlog entry parameters, * for example to make a relative URI absolute with respect to the diff --git a/java/src/org/apache/xml/resolver/CatalogException.java b/java/src/org/apache/xml/resolver/CatalogException.java index 27170e6..df6aad9 100644 --- a/java/src/org/apache/xml/resolver/CatalogException.java +++ b/java/src/org/apache/xml/resolver/CatalogException.java @@ -60,7 +60,7 @@ package org.apache.xml.resolver; /** - *
Signal Catalog exception.
+ * Signal Catalog exception. * *This exception is thrown if an error occurs loading a * catalog file.
diff --git a/java/src/org/apache/xml/resolver/CatalogManager.java b/java/src/org/apache/xml/resolver/CatalogManager.java index 511b124..24fda75 100644 --- a/java/src/org/apache/xml/resolver/CatalogManager.java +++ b/java/src/org/apache/xml/resolver/CatalogManager.java @@ -69,7 +69,7 @@ import org.apache.xml.resolver.helpers.Debug; import org.apache.xml.resolver.Catalog; /** - *CatalogManager provides an interface to the catalog properties.
+ * CatalogManager provides an interface to the catalog properties. * *Properties can come from two places: from system properties or * from a CatalogManager.properties 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 { *
In the properties, a value of 'yes', 'true', or '1' is considered * true, anything else is false.
* - * @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 { *In the properties, a value of 'public' is true, * anything else is false.
* - * @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 { *In the properties, a value of 'yes', 'true', or '1' is considered * true, anything else is false.
* - * @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 { *In the properties, a value of 'yes', 'true', or '1' is considered * true, anything else is false.
* - * @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 { } /** - *Obtain the Catalog class name setting from the properties.
+ * Obtain the Catalog class name setting from the properties. * */ public String queryCatalogClassName () { diff --git a/java/src/org/apache/xml/resolver/Resolver.java b/java/src/org/apache/xml/resolver/Resolver.java index 7fc9ed9..7236d0e 100644 --- a/java/src/org/apache/xml/resolver/Resolver.java +++ b/java/src/org/apache/xml/resolver/Resolver.java @@ -73,8 +73,8 @@ import org.apache.xml.resolver.readers.TR9401CatalogReader; import javax.xml.parsers.SAXParserFactory; /** - *An extension to OASIS Open Catalog files, this class supports - * suffix-based matching and an external RFC2483 resolver.
+ * 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 { /** - *The URISUFFIX Catalog Entry type.
+ * The URISUFFIX Catalog Entry type. * *URI suffix entries match URIs that end in a specified suffix.
*/ public static final int URISUFFIX = CatalogEntry.addEntryType("URISUFFIX", 2); /** - *The SYSTEMSUFFIX Catalog Entry type.
+ * The SYSTEMSUFFIX Catalog Entry type. * *System suffix entries match system identifiers that end in a * specified suffix.
@@ -100,14 +100,14 @@ public class Resolver extends Catalog { public static final int SYSTEMSUFFIX = CatalogEntry.addEntryType("SYSTEMSUFFIX", 2); /** - *The RESOLVER Catalog Entry type.
+ * The RESOLVER Catalog Entry type. * *A hook for providing support for web-based backup resolvers.
*/ public static final int RESOLVER = CatalogEntry.addEntryType("RESOLVER", 1); /** - *The SYSTEMREVERSE Catalog Entry type.
+ * The SYSTEMREVERSE Catalog Entry type. * *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); /** - *
Setup readers.
+ * Setup readers. */ public void setupReaders() { SAXParserFactory spf = SAXParserFactory.newInstance(); @@ -141,7 +141,7 @@ public class Resolver extends Catalog { } /** - *Cleanup and process a Catalog entry.
+ * Cleanup and process a Catalog entry. * *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 { } /** - *
Return the applicable URI
+ * Return the applicable URI. * *If a URI entry exists in the Catalog * for the URI specified, return the mapped value.
@@ -227,8 +227,8 @@ public class Resolver extends Catalog { } /** - *Return the applicable SYSTEM system identifier, resorting - * to external RESOLVERs if necessary.
+ * Return the applicable SYSTEM system identifier, resorting + * to external RESOLVERs if necessary. * *If a SYSTEM entry exists in the Catalog * for the system ID specified, return the mapped value.
@@ -283,8 +283,8 @@ public class Resolver extends Catalog { } /** - *Return the applicable PUBLIC or SYSTEM identifier, resorting - * to external resolvers if necessary.
+ * Return the applicable PUBLIC or SYSTEM identifier, resorting + * to external resolvers if necessary. * *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 { } /** - *
Query an external RFC2483 resolver for a system identifier.
+ * 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 { } /** - *Query an external RFC2483 resolver for a public identifier.
+ * 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 { } /** - *Query an external RFC2483 resolver.
+ * 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 { } /** - *Append two vectors, returning the result.
+ * 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 { } /** - *Find the URNs for a given system identifier in all catalogs.
+ * 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 { } /** - *Find the URN for a given system identifier.
+ * Find the URN for a given system identifier. * * @param systemId The system ID to locate. * @@ -495,7 +495,7 @@ public class Resolver extends Catalog { } /** - *Return the applicable SYSTEM system identifiers
+ * Return the applicable SYSTEM system identifiers. * *If one or more SYSTEM entries exists in the Catalog * for the system ID specified, return the mapped values.
@@ -546,8 +546,8 @@ public class Resolver extends Catalog { } /** - *Return all applicable SYSTEM system identifiers in this - * catalog.
+ * Return all applicable SYSTEM system identifiers in this + * catalog. * *If one or more SYSTEM entries exists in the catalog file * for the system ID specified, return the mapped values.
@@ -578,7 +578,7 @@ public class Resolver extends Catalog { } /** - *Find the URNs for a given system identifier in the current catalog.
+ * 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 { } /** - *Search the subordinate catalogs, in order, looking for all - * match.
+ * Search the subordinate catalogs, in order, looking for all + * match. * *This method searches the Catalog and returns all of the system * identifiers specified for the given entity type with the given diff --git a/java/src/org/apache/xml/resolver/apps/XParseError.java b/java/src/org/apache/xml/resolver/apps/XParseError.java index 880c590..ba1ceae 100644 --- a/java/src/org/apache/xml/resolver/apps/XParseError.java +++ b/java/src/org/apache/xml/resolver/apps/XParseError.java @@ -66,7 +66,7 @@ import org.xml.sax.*; import org.xml.sax.helpers.*; /** - *
An ErrorHandler for xparse.
+ * An ErrorHandler for xparse. * *This class is just the error handler for xparse.
* diff --git a/java/src/org/apache/xml/resolver/apps/package.html b/java/src/org/apache/xml/resolver/apps/package.html index a04bf36..362830b 100644 --- a/java/src/org/apache/xml/resolver/apps/package.html +++ b/java/src/org/apache/xml/resolver/apps/package.html @@ -3,7 +3,7 @@Apache XML Commons Resolver Applications package
+Apache XML Commons Resolver Applications package.
This package provides a few simple command-line tools for exploring the facilities of the resolver.
diff --git a/java/src/org/apache/xml/resolver/apps/resolver.java b/java/src/org/apache/xml/resolver/apps/resolver.java index e2f7efc..846674b 100644 --- a/java/src/org/apache/xml/resolver/apps/resolver.java +++ b/java/src/org/apache/xml/resolver/apps/resolver.java @@ -77,7 +77,7 @@ import org.apache.xml.resolver.helpers.Debug; import org.apache.xml.resolver.tools.CatalogResolver; /** - *A simple command-line resolver.
+ * A simple command-line resolver. * *This class implements a simple command-line resolver. It takes * some parameters and passes them through the resolver, printing the diff --git a/java/src/org/apache/xml/resolver/apps/xparse.java b/java/src/org/apache/xml/resolver/apps/xparse.java index a3d68bd..c8cba07 100644 --- a/java/src/org/apache/xml/resolver/apps/xparse.java +++ b/java/src/org/apache/xml/resolver/apps/xparse.java @@ -75,7 +75,7 @@ import org.apache.xml.resolver.CatalogManager; import org.apache.xml.resolver.helpers.Debug; /** - *
A simple command-line XML parsing application.
+ * A simple command-line XML parsing application. * *This class implements a simple command-line XML Parser. It's * just a little wrapper around the JAXP Parser with support for diff --git a/java/src/org/apache/xml/resolver/apps/xread.java b/java/src/org/apache/xml/resolver/apps/xread.java index 8c8cf89..02ff22c 100644 --- a/java/src/org/apache/xml/resolver/apps/xread.java +++ b/java/src/org/apache/xml/resolver/apps/xread.java @@ -75,7 +75,7 @@ import org.apache.xml.resolver.CatalogManager; import org.apache.xml.resolver.helpers.Debug; /** - *
A simple command-line XML parsing application.
+ * A simple command-line XML parsing application. * *This class implements a simple command-line XML Parser. It's * just a little wrapper around the JAXP XMLReader with support for diff --git a/java/src/org/apache/xml/resolver/helpers/Debug.java b/java/src/org/apache/xml/resolver/helpers/Debug.java index 9797d6f..95d3b71 100644 --- a/java/src/org/apache/xml/resolver/helpers/Debug.java +++ b/java/src/org/apache/xml/resolver/helpers/Debug.java @@ -60,7 +60,7 @@ package org.apache.xml.resolver.helpers; /** - *
Static debugging/messaging class for Catalogs.
+ * Static debugging/messaging class for Catalogs. * *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 { } /** - *
Print debug message (if the debug level is high enough).
+ * Print debug message (if the debug level is high enough). * *Prints "the message"
* @@ -108,7 +108,7 @@ public class Debug { } /** - *Print debug message (if the debug level is high enough).
+ * Print debug message (if the debug level is high enough). * *Prints "the message: spec"
* @@ -126,7 +126,7 @@ public class Debug { } /** - *Print debug message (if the debug level is high enough).
+ * Print debug message (if the debug level is high enough). * *Prints "the message: spec1" and "spec2" indented on the next line.
* diff --git a/java/src/org/apache/xml/resolver/helpers/Namespaces.java b/java/src/org/apache/xml/resolver/helpers/Namespaces.java index ffd2fba..a7eecb9 100644 --- a/java/src/org/apache/xml/resolver/helpers/Namespaces.java +++ b/java/src/org/apache/xml/resolver/helpers/Namespaces.java @@ -62,7 +62,7 @@ package org.apache.xml.resolver.helpers; import org.w3c.dom.*; /** - *Static Namespace query methods.
+ * Static Namespace query methods. * *This class defines a set of static methods that can be called * to analyze the namespace properties of DOM nodes.
@@ -74,8 +74,8 @@ import org.w3c.dom.*; */ public class Namespaces { /** - *Returns the "prefix" part of a QName or the empty string (not - * null) if the name has no prefix.
+ * 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 { } /** - *Returns the "localname" part of a QName, which is the whole - * name if it has no prefix.
+ * 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 { } /** - *Returns the namespace URI for the specified prefix at the - * specified context node.
+ * 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 { } /** - *Returns the namespace URI for the namespace to which the - * element belongs.
+ * 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 diff --git a/java/src/org/apache/xml/resolver/helpers/PublicId.java b/java/src/org/apache/xml/resolver/helpers/PublicId.java index b964d90..c559ef6 100644 --- a/java/src/org/apache/xml/resolver/helpers/PublicId.java +++ b/java/src/org/apache/xml/resolver/helpers/PublicId.java @@ -60,7 +60,7 @@ package org.apache.xml.resolver.helpers; /** - *Static methods for dealing with public identifiers.
+ * Static methods for dealing with public identifiers. * *This class defines a set of static methods that can be called * to handle public identifiers.
@@ -74,7 +74,7 @@ public abstract class PublicId { protected PublicId() { } /** - *Normalize a public identifier.
+ * Normalize a public identifier. * *Public identifiers must be normalized according to the following * rules before comparisons between them can be made:
@@ -110,7 +110,7 @@ public abstract class PublicId { } /** - *Encode a public identifier as a "publicid" URN.
+ * Encode a public identifier as a "publicid" URN. * *This method is declared static so that other classes * can use it directly.
@@ -138,7 +138,7 @@ public abstract class PublicId { } /** - *Decode a "publicid" URN into a public identifier.
+ * Decode a "publicid" URN into a public identifier. * *This method is declared static so that other classes * can use it directly.
@@ -172,7 +172,7 @@ public abstract class PublicId { } /** - *Replace one string with another.
+ * Replace one string with another. * */ private static String stringReplace(String str, diff --git a/java/src/org/apache/xml/resolver/helpers/package.html b/java/src/org/apache/xml/resolver/helpers/package.html index a0ad685..c72c51d 100644 --- a/java/src/org/apache/xml/resolver/helpers/package.html +++ b/java/src/org/apache/xml/resolver/helpers/package.html @@ -3,7 +3,7 @@Apache XML Commons Resolver Helpers package
+Apache XML Commons Resolver Helpers package.
This package provides a collection of static helper functions used across a number of different classes.
diff --git a/java/src/org/apache/xml/resolver/package.html b/java/src/org/apache/xml/resolver/package.html index 9e80df3..60fa52c 100644 --- a/java/src/org/apache/xml/resolver/package.html +++ b/java/src/org/apache/xml/resolver/package.html @@ -3,7 +3,7 @@Apache XML Commons Resolver package
+Apache XML Commons Resolver package.