CatalogManager (FlexDoc/Javadoc 2.0 Demo)

FlexDoc/Javadoc 2.0
Demo Java Doc

Class CatalogManager

javax.xml.catalog.CatalogManager

public final class CatalogManager

The Catalog Manager manages the creation of XML Catalogs and Catalog Resolvers.

catalog(CatalogFeatures features, URI... uris)

Creates a Catalog object using the specified feature settings and uri(s) to one or more catalog files.

Creates an instance of a CatalogResolver using the specified catalog.

Creates an instance of a CatalogResolver using the specified feature settings and uri(s) to one or more catalog files.

Methods inherited from class java.lang.Object

public static Catalog catalog

(CatalogFeatures features,
URI... uris)

Creates a Catalog object using the specified feature settings and uri(s) to one or more catalog files.

If uris is empty, system property javax.xml.catalog.files, as defined in CatalogFeatures, will be read to locate the initial list of catalog files.

If multiple catalog files are specified through the uris argument or javax.xml.catalog.files property, the first entry is considered the main catalog, while others are treated as alternative catalogs after those referenced by the nextCatalog elements in the main catalog.

As specified in XML Catalogs, OASIS Standard V1.1, if a catalog entry is invalid, it is ignored. In case all entries are invalid, the resulting Catalog object will contain no Catalog elements. Any matching operation using the Catalog will return null.

Parameters:

features - the catalog features

uris - uri(s) to one or more catalogs.

Returns:

an instance of a Catalog

Throws:

IllegalArgumentException - if either the URIs are not absolute or do not have a URL protocol handler for the URI scheme

CatalogException - If an error occurs while parsing the catalog

SecurityException - if access to the resource is denied by the security manager

public static CatalogResolver catalogResolver

Creates an instance of a CatalogResolver using the specified catalog.

Parameters:

catalog - the catalog instance

Returns:

an instance of a CatalogResolver

public static CatalogResolver catalogResolver

(CatalogFeatures features,
URI... uris)

Creates an instance of a CatalogResolver using the specified feature settings and uri(s) to one or more catalog files.

If uris is empty, system property javax.xml.catalog.files, as defined in CatalogFeatures, will be read to locate the initial list of catalog files.

As specified in XML Catalogs, OASIS Standard V1.1, if a catalog entry is invalid, it is ignored. In case all entries are invalid, the resulting CatalogResolver object will contain no valid catalog. Any resolution operation using the resolver therefore will return as no mapping is found. See CatalogResolver for the behavior when no mapping is found.

Parameters:

features - the catalog features

uris - the uri(s) to one or more catalogs

Returns:

an instance of a CatalogResolver

Throws:

IllegalArgumentException - if either the URIs are not absolute or do not have a URL protocol handler for the URI scheme

CatalogException - If an error occurs while parsing the catalog

SecurityException - if access to the resource is denied by the security manager

FlexDoc/Javadoc 2.0
Demo Java Doc

Java API documentation generated with FlexDoc/Javadoc 2.0 using JavadocClassic 3.0 template set.

FlexDoc/Javadoc is a template-driven programming tool for rapid development of any Javadoc-based Java API documentation generators (i.e. doclets). If you need to customize your Javadoc without writing a full-blown doclet from scratch, FlexDoc/Javadoc may be the only tool able to help you! Find out more at www.flexdoc.xyz

Method Summary
static Catalog	catalog(CatalogFeatures features, URI... uris) Creates a Catalog object using the specified feature settings and uri(s) to one or more catalog files.
static CatalogResolver	catalogResolver(Catalog catalog) Creates an instance of a CatalogResolver using the specified catalog.
static CatalogResolver	catalogResolver(CatalogFeatures features, URI... uris) Creates an instance of a CatalogResolver using the specified feature settings and uri(s) to one or more catalog files.