javax.xml.catalog

Class CatalogManager

java.lang.Object

javax.xml.catalog.CatalogManager

public final class CatalogManager
extends Object

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

Since:

9

Method Summary

Modifier and Type	Method and Description
static Catalog	catalog(CatalogFeatures features, String... paths) Creates a Catalog object using the specified feature settings and path 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, String... paths) Creates an instance of a CatalogResolver using the specified feature settings and path to one or more catalog files.
static CatalogUriResolver	catalogUriResolver(Catalog catalog) Creates an instance of a CatalogUriResolver using the specified catalog.
static CatalogUriResolver	catalogUriResolver(CatalogFeatures features, String... paths) Creates an instance of a CatalogUriResolver using the specified feature settings and path to one or more catalog files.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

catalog

public static Catalog catalog(CatalogFeatures features,
                              String... paths)

Creates a Catalog object using the specified feature settings and path to one or more catalog files.

If paths is empty, system property javax.xml.catalog.files will be read to locate the initial list of catalog files.

If more than one catalog files are specified through the paths 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, invalid path entries will be ignored. No error will be reported. In case all entries are invalid, the resolver will return as no mapping is found.

Parameters:

features - the catalog features

paths - path(s) to one or more catalogs.

Returns:

an instance of a Catalog

Throws:

CatalogException - If an error occurs while parsing the catalog

catalogResolver

public static CatalogResolver catalogResolver(Catalog catalog)

Creates an instance of a CatalogResolver using the specified catalog.

Parameters:

catalog - the catalog instance

Returns:

an instance of a CatalogResolver

catalogUriResolver

public static CatalogUriResolver catalogUriResolver(Catalog catalog)

Creates an instance of a CatalogUriResolver using the specified catalog.

Parameters:

catalog - the catalog instance

Returns:

an instance of a CatalogResolver

catalogResolver

public static CatalogResolver catalogResolver(CatalogFeatures features,
                                              String... paths)

Creates an instance of a CatalogResolver using the specified feature settings and path to one or more catalog files.

If paths is empty, system property javax.xml.catalog.files will be read to locate the initial list of catalog files.

If more than one catalog files are specified through the paths 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, invalid path entries will be ignored. No error will be reported. In case all entries are invalid, the resolver will return as no mapping is found.

Parameters:

features - the catalog features

paths - the path(s) to one or more catalogs

Returns:

an instance of a CatalogResolver

Throws:

CatalogException - If an error occurs while parsing the catalog

catalogUriResolver

public static CatalogUriResolver catalogUriResolver(CatalogFeatures features,
                                                    String... paths)

Creates an instance of a CatalogUriResolver using the specified feature settings and path to one or more catalog files.

If paths is empty, system property javax.xml.catalog.files will be read to locate the initial list of catalog files.

If more than one catalog files are specified through the paths 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, invalid path entries will be ignored. No error will be reported. In case all entries are invalid, the resolver will return as no mapping is found.

Parameters:

features - the catalog features

paths - the path(s) to one or more catalogs

Returns:

an instance of a CatalogUriResolver

Throws:

CatalogException - If an error occurs while parsing the catalog