Class CatalogManager
- Since:
- 9
-
Method Summary
Modifier and TypeMethodDescriptionstatic Catalogcatalog(CatalogFeatures features, URI... uris) Creates aCatalogobject using the specified feature settings and uri(s) to one or more catalog files.static CatalogResolvercatalogResolver(Catalog catalog) Creates an instance of aCatalogResolverusing the specified catalog.static CatalogResolvercatalogResolver(CatalogFeatures features, URI... uris) Creates an instance of aCatalogResolverusing the specified feature settings and uri(s) to one or more catalog files.static CatalogResolvercatalogResolver(Catalog catalog, CatalogResolver.NotFoundAction action) Creates aCatalogResolverthat resolves external references with the givencatalogandactiontype that determines the behavior when unable to resolve a reference.
-
Method Details
-
catalog
Creates aCatalogobject using the specified feature settings and uri(s) to one or more catalog files.If
urisis empty, system propertyjavax.xml.catalog.files, as defined inCatalogFeatures, will be read to locate the initial list of catalog files.If multiple catalog files are specified through the
urisargument orjavax.xml.catalog.filesproperty, the first entry is considered the main catalog, while others are treated as alternative catalogs after those referenced by thenextCatalogelements 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 featuresuris- 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 schemeCatalogException- If an error occurs while parsing the catalog
-
catalogResolver
Creates an instance of aCatalogResolverusing the specified catalog.- API Note:
- The
CatalogResolvercreated by this method delegates to the underlyingcatalog's RESOLVE property. TheCatalogResolvercreated bycatalogResover(Catalog, CatalogResolver.NotFoundAction)is based on the specified action type when it is unable to resolve a reference. - Parameters:
catalog- the catalog instance- Returns:
- an instance of a
CatalogResolver
-
catalogResolver
public static CatalogResolver catalogResolver(Catalog catalog, CatalogResolver.NotFoundAction action) Creates aCatalogResolverthat resolves external references with the givencatalogandactiontype that determines the behavior when unable to resolve a reference.The
actiontypes are mapped to the values of theRESOLVEproperty.- Parameters:
catalog- the catalog instanceaction- the action to be taken when unable to resolve a reference- Returns:
- a
CatalogResolverwith thecatalogandactiontype - Since:
- 22
-
catalogResolver
Creates an instance of aCatalogResolverusing the specified feature settings and uri(s) to one or more catalog files.If
urisis empty, system propertyjavax.xml.catalog.files, as defined inCatalogFeatures, will be read to locate the initial list of catalog files.If multiple catalog files are specified through the
urisargument orjavax.xml.catalog.filesproperty, the first entry is considered the main catalog, while others are treated as alternative catalogs after those referenced by thenextCatalogelements 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 CatalogResolver object will contain no valid catalog. Any resolution operation using the resolver therefore will return as no mapping is found. See
CatalogResolverfor the behavior when no mapping is found.- Parameters:
features- the catalog featuresuris- 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 schemeCatalogException- If an error occurs while parsing the catalog
-