org.xmlresolver.package-info Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xmlresolver Show documentation

An XML entity/uri resolver

There is a newer version: 6.0.11

/** The XML (Catalog) Resolver.
 *
 * The resolver maps external identifiers (document type declarations
 * and external parsed entities) and URIs found in XML documents to other
 * resources. This implementation supports additional interfaces to
 * perform redirection through RDDL documents and automated caching of
 * resources retrieved from the web.
 *
 * TL;DR
 *
 * Instantiate an {@link org.xmlresolver.XMLResolver} (it has a zero argument constructor
 * so that it can be instantiated just from its name). Use the methods provided on the {@code XMLResolver}
 * to instantiate the resolver interfaces that you require.
 *
 * Tell your processor to instantiate a
 * {@link org.xmlresolver.tools.ResolvingXMLReader} for parsing.
 *
 * L;OS (long; only skimmed)
 *
 * For most users, the principle entry points to this API will be the
 * {@link org.xmlresolver.XMLResolver} class and the {@link org.xmlresolver.tools.ResolvingXMLReader}. These instantiate
 * a resolver that can be configured with either system properties or
 * a properties file.
 *
 * The {@link org.xmlresolver.XMLResolver} has methods to construct a wide variety of resolver interfaces:
 *
 * 
 * javax.xml.transform.URIResolver {@link org.xmlresolver.XMLResolver#getURIResolver}.
 * org.w3c.dom.ls.LSResourceResolver {@link org.xmlresolver.XMLResolver#getLSResourceResolver()}.
 * org.xml.sax.EntityResolver {@link org.xmlresolver.XMLResolver#getEntityResolver()}.
 * org.xml.sax.ext.EntityResolver2 {@link org.xmlresolver.XMLResolver#getEntityResolver2()}.
 * {@link javax.xml.stream.XMLResolver} {@link org.xmlresolver.XMLResolver#getXMLResolver()}
 * 
 *
 * The ResolvingXMLReader class extends the SAX parser so that
 * it will automatically construct and use a resolver.
 *
 * 
Accessing the resolver
 *
 * The resolver is configured with a {@link org.xmlresolver.ResolverConfiguration}, more specifically
 * in this release, an {@link org.xmlresolver.XMLResolverConfiguration}. This class allows you to configure
 * features of the resolver.
 */

package org.xmlresolver;