| java.lang.Object
 nu.xom.xinclude.XIncluder
| XIncluder | | public class XIncluder (Code) | |
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.
author:
Elliotte Rusty Harold
version:
1.1b3 |
| Field Summary | |
| final public static String | XINCLUDE_NS
The namespace name of all XInclude elements. |
| Method Summary | |
| public static Document | resolve(Document in)
Returns a copy of the document in which all
xinclude:include elements have been
replaced by their referenced content. | | public static Document | resolve(Document in, Builder builder)
Returns a copy of the document in which all
xinclude:include elements have been
replaced by their referenced content as loaded by the builder. | | public static void | resolveInPlace(Document in)
Modifies a document by replacing all
xinclude:include elements
by their referenced content. | | public static void | resolveInPlace(Document in, Builder builder)
Modifies a document by replacing all
xinclude:include elements with their referenced
content as loaded by the builder. |
| XINCLUDE_NS | | final public static String XINCLUDE_NS(Code) | |
The namespace name of all XInclude elements.
|
| resolve | | public static Document resolve(Document in) throws BadParseAttributeException, InclusionLoopException, IOException, NoIncludeLocationException, ParsingException, UnsupportedEncodingException, XIncludeException(Code) | |
Returns a copy of the document in which all
xinclude:include elements have been
replaced by their referenced content. The original
Document object is not modified.
Resolution is recursive; that is, include elements
in the included documents are themselves resolved.
The Document returned contains no
include elements.
Parameters:
in - the document in which include elementsshould be resolved copy of the document in whichall xinclude:include elementshave been replaced by their referenced content
throws:
BadParseAttributeException - if an include element has a parse attribute with any value other than text or parse
throws:
InclusionLoopException - if the document contains an XInclude element that attempts to include a document in which this element is directly or indirectly included.
throws:
IOException - if an included document could not be loaded,and no fallback was available
throws:
NoIncludeLocationException - if an xinclude:include element does not have an href attribute
throws:
ParsingException - if an included XML document was malformed
throws:
UnsupportedEncodingException - if an included document used an encoding this parser does not support, and nofallback was available
throws:
XIncludeException - if the document violates thesyntax rules of XInclude
throws:
XMLException - if resolving an include element would result in a malformed document |
| resolve | | public static Document resolve(Document in, Builder builder) throws BadParseAttributeException, InclusionLoopException, IOException, NoIncludeLocationException, ParsingException, UnsupportedEncodingException, XIncludeException(Code) | |
Returns a copy of the document in which all
xinclude:include elements have been
replaced by their referenced content as loaded by the builder.
The original Document object is not modified.
Resolution is recursive; that is, include elements
in the included documents are themselves resolved.
The document returned contains no include elements.
Parameters:
in - the document in which include elementsshould be resolved
Parameters:
builder - the builder used to build thenodes included from other documents copy of the document in whichall xinclude:include elementshave been replaced by their referenced content
throws:
BadParseAttributeException - if an include element has a parse attribute with any value other than text or parse
throws:
InclusionLoopException - if the document contains an XInclude element that attempts to include a document in which this element is directly or indirectly included.
throws:
IOException - if an included document could not be loaded,and no fallback was available
throws:
NoIncludeLocationException - if an xinclude:include element does not have an href attribute.
throws:
ParsingException - if an included XML document was malformed
throws:
UnsupportedEncodingException - if an included document used an encoding this parser does not support, and nofallback was available
throws:
XIncludeException - if the document violates thesyntax rules of XInclude
throws:
XMLException - if resolving an include element would result in a malformed document |
| resolveInPlace | | public static void resolveInPlace(Document in) throws BadParseAttributeException, InclusionLoopException, IOException, NoIncludeLocationException, ParsingException, UnsupportedEncodingException, XIncludeException(Code) | |
Modifies a document by replacing all
xinclude:include elements
by their referenced content.
Resolution is recursive; that is, include elements
in the included documents are themselves resolved.
The resolved document contains no
xinclude:include elements.
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 elementsshould be resolved
throws:
BadParseAttributeException - if an include element has a parse attributewith any value other than text or parse
throws:
InclusionLoopException - if the document contains an XInclude element that attempts to include a document in which this element is directly or indirectly included
throws:
IOException - if an included document could not be loaded,and no fallback was available
throws:
NoIncludeLocationException - if an xinclude:includeelement does not have an href attribute
throws:
ParsingException - if an included XML documentwas malformed
throws:
UnsupportedEncodingException - if an included document used an encoding this parser does not support, and no fallback was available
throws:
XIncludeException - if the document violates thesyntax rules of XInclude
throws:
XMLException - if resolving an include element would result in a malformed document |
| resolveInPlace | | public static void resolveInPlace(Document in, Builder builder) throws BadParseAttributeException, InclusionLoopException, IOException, NoIncludeLocationException, ParsingException, UnsupportedEncodingException, XIncludeException(Code) | |
Modifies a document by replacing all
xinclude:include elements with their referenced
content as loaded by the builder. Resolution is recursive;
that is, include elements in the included documents
are themselves resolved. The resolved document contains no
xinclude:include elements.
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 elementsshould be resolved
Parameters:
builder - the builder used to build thenodes included from other documents
throws:
BadParseAttributeException - if an include element has a parse attributewith any value other than text or parse
throws:
InclusionLoopException - if this element contains an XInclude element that attempts to include a document in which this element is directly or indirectly included
throws:
IOException - if an included document could not be loaded,and no fallback was available
throws:
NoIncludeLocationException - if an xinclude:includeelement does not have an href attribute.
throws:
ParsingException - if an included XML documentwas malformed
throws:
UnsupportedEncodingException - if an included document used an encoding this parser does not support, and no fallback was available
throws:
XIncludeException - if the document violates thesyntax rules of XInclude
throws:
XMLException - if resolving an include element would result in a malformed document |
|
|