Class XIncluder
Implements XInclude resolution as specified in
XML Inclusions (XInclude) Version
1.0. Fallbacks are supported.
The XPointer element() scheme and
shorthand XPointers are also supported. The XPointer
xpointer() scheme is not supported.
The accept and accept-language
attributes are supported.
- Version:
- 1.3.9
- Author:
- Elliotte Rusty Harold
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe namespace name of all XInclude elements. -
Method Summary
Modifier and TypeMethodDescriptionstatic DocumentReturns a copy of the document in which allxinclude:includeelements have been replaced by their referenced content.static DocumentReturns a copy of the document in which allxinclude:includeelements have been replaced by their referenced content as loaded by the builder.static voidModifies a document by replacing allxinclude:includeelements by their referenced content.static voidresolveInPlace(Document in, Builder builder) Modifies a document by replacing allxinclude:includeelements with their referenced content as loaded by the builder.
-
Field Details
-
XINCLUDE_NS
The namespace name of all XInclude elements.
- See Also:
-
-
Method Details
-
resolve
public static Document resolve(Document in) throws BadParseAttributeException, InclusionLoopException, IOException, NoIncludeLocationException, ParsingException, UnsupportedEncodingException, XIncludeException Returns a copy of the document in which all
xinclude:includeelements have been replaced by their referenced content. The originalDocumentobject is not modified. Resolution is recursive; that is, include elements in the included documents are themselves resolved. TheDocumentreturned contains no include elements.- Parameters:
in- the document in which include elements should be resolved- Returns:
- copy of the document in which
all
xinclude:includeelements have been replaced by their referenced content
-
resolve
public static Document resolve(Document in, Builder builder) throws BadParseAttributeException, InclusionLoopException, IOException, NoIncludeLocationException, ParsingException, UnsupportedEncodingException, XIncludeException Returns a copy of the document in which all
xinclude:includeelements have been replaced by their referenced content as loaded by the builder. The originalDocumentobject is not modified. Resolution is recursive; that is, include elements in the included documents are themselves resolved. The document returned contains noincludeelements.- Parameters:
in- the document in which include elements should be resolvedbuilder- the builder used to build the nodes included from other documents- Returns:
- copy of the document in which
all
xinclude:includeelements have been replaced by their referenced content
-
resolveInPlace
public static void resolveInPlace(Document in) throws BadParseAttributeException, InclusionLoopException, IOException, NoIncludeLocationException, ParsingException, UnsupportedEncodingException, XIncludeException Modifies a document by replacing all
xinclude:includeelements by their referenced content. Resolution is recursive; that is, include elements in the included documents are themselves resolved. The resolved document contains noxinclude:includeelements.If the inclusion fails for any reason—XInclude syntax error, missing resource with no fallback, etc.—the document may be left in a partially resolved state.
- Parameters:
in- the document in which include elements should be resolved
-
resolveInPlace
public static void resolveInPlace(Document in, Builder builder) throws BadParseAttributeException, InclusionLoopException, IOException, NoIncludeLocationException, ParsingException, UnsupportedEncodingException, XIncludeException Modifies a document by replacing all
xinclude:includeelements with their referenced content as loaded by the builder. Resolution is recursive; that is,includeelements in the included documents are themselves resolved. The resolved document contains noxinclude:includeelements.If the inclusion fails for any reason — XInclude syntax error, missing resource with no fallback, etc. — the document may be left in a partially resolved state.
- Parameters:
in- the document in which include elements should be resolvedbuilder- the builder used to build the nodes included from other documents
-