|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnu.xom.Builder
The Builder
class is responsible
for creating XOM Document
objects
from a URL, file, string, or input stream by reading
an XML document. A SAX parser is used to read the
document and report any well-formedness errors.
Constructor Summary | |
Builder()
Creates a Builder that uses the default node
factory and chooses among any available SAX2 parsers in the
following order:
|
|
Builder(boolean validate)
Creates a Builder based on a fully validating
parser. |
|
Builder(boolean validate,
NodeFactory factory)
Creates a Builder based on a fully
validating parser that builds node objects with the supplied
factory. |
|
Builder(NodeFactory factory)
Creates a Builder that uses
the specified NodeFactory to create
node objects. |
|
Builder(org.xml.sax.XMLReader parser)
Creates a Builder based
on the specified SAX parser XMLReader . |
|
Builder(org.xml.sax.XMLReader parser,
boolean validate)
Creates a Builder based
on the specified parser object. |
|
Builder(org.xml.sax.XMLReader parser,
boolean validate,
NodeFactory factory)
Creates a Builder that reads data
from the specified parser object and constructs new nodes using
the specified factory object. |
Method Summary | |
Document |
build(java.io.File in)
Reads the document from a file. |
Document |
build(java.io.InputStream in)
Reads the document from an input stream. |
Document |
build(java.io.InputStream in,
java.lang.String baseURI)
Reads the document from an input stream while allowing a base URI to be specified. |
Document |
build(java.io.Reader in)
Reads the document from a reader. |
Document |
build(java.io.Reader in,
java.lang.String baseURI)
Reads the document from an input stream while allowing a base URI to be specified. |
Document |
build(java.lang.String systemID)
Parses the document at the specified URL. |
Document |
build(java.lang.String document,
java.lang.String baseURI)
Reads the document from the contents of a String . |
NodeFactory |
getNodeFactory()
If a custom NodeFactory was passed to the
constructor, then this method returns a reference to it. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public Builder()
Creates a Builder
that uses the default node
factory and chooses among any available SAX2 parsers in the
following order:
org.xml.sax.driver
system propertyParsers must implicitly or explicitly support the http://xml.org/sax/features/external-general-entities and http://xml.org/sax/features/external-parameter-entities features XOM requires. Parsers that don't are rejected automatically.
XMLException
- if no satisfactory parser is
installed in the local class pathpublic Builder(boolean validate)
Creates a Builder
based on a fully validating
parser. If the validate
argument
is true, then a validity error while
parsing will cause a fatal error; that is,
it will throw a ValidityException
.
validate
- true if the parser should
validate the document while parsing
XMLException
- if no satisfactory parser
is installed in the local class pathpublic Builder(boolean validate, NodeFactory factory)
Creates a Builder
based on a fully
validating parser that builds node objects with the supplied
factory. If the validate
argument is true, then
a validity error while parsing will cause a fatal error; that
is, it will throw a ValidityException
.
validate
- true if the parser should
validate the document while parsingfactory
- the NodeFactory
that creates
the node objects for this Builder
XMLException
- if no satisfactory parser
is installed in the local class pathpublic Builder(org.xml.sax.XMLReader parser)
Creates a Builder
based
on the specified SAX parser XMLReader
.
Custom SAX features and properties such as
schema validation can be set on this XMLReader
before passing it to this method.
parser
- the SAX2 XMLReader
that
parses the document
XMLException
- if parser does not support the
features XOM requirespublic Builder(NodeFactory factory)
Creates a Builder
that uses
the specified NodeFactory
to create
node objects.
factory
- the NodeFactory
that creates
the node objects for this Builder
XMLException
- if parser does not support the
features XOM requirespublic Builder(org.xml.sax.XMLReader parser, boolean validate)
Creates a Builder
based
on the specified parser object.
Custom SAX features and properties such
as schema validation can be set on this
XMLReader
before passing it
to this method.
If the validate argument is true, then a validity error
while parsing will cause a fatal error; that is, it
will throw a ParsingException
parser
- the SAX2 XMLReader
that parses
the documentvalidate
- true if the parser should validate
the document while parsingpublic Builder(org.xml.sax.XMLReader parser, boolean validate, NodeFactory factory)
Creates a Builder
that reads data
from the specified parser object and constructs new nodes using
the specified factory object. Custom SAX features and properties
such as schema validation can be set on this
XMLReader
before passing it to this method.
If the validate argument is true, then a validity error
while parsing will cause a fatal error; that is,
it will throw a ParsingException
parser
- the SAX2 XMLReader
that parses
the documentvalidate
- true if the parser should validate the
document while parsingfactory
- the NodeFactory
this builder uses to create objects in the tree
XMLException
- if parser does not support
the features XOM requiresMethod Detail |
public Document build(java.lang.String systemID) throws ParsingException, ValidityException, java.io.IOException
Parses the document at the specified URL.
Note that relative URLs generally do not work here, as
there's no base to resolve them against. This includes
relative URLs that point into the file system, though this
is somewhat platform dependent. Furthermore, file
URLs often only work when they adhere exactly to RFC 2396
syntax. URLs that work in Internet Explorer often fail when
used in Java. If you're reading XML from a file, more reliable
results are obtained by using the build
method
that takes a java.io.File
object as an argument.
systemID
- the URL (generally absolute)
from which the document is read.
The URL's scheme must be one supported by the Java VM.
Document
ValidityException
- if a validity error is detected. This
is only thrown if the builder has been instructed to validate.
ParsingException
- if a well-formedness error is detected
java.io.IOException
- if an I/O error such as a broken socket
prevents the document from being fully readpublic Document build(java.io.InputStream in) throws ParsingException, ValidityException, java.io.IOException
Reads the document from an input stream.
in
- the InputStream
from which the
document is read
Document
ValidityException
- if a validity error is detected;
only thrown if the builder has been instructed to validate
ParsingException
- if a well-formedness error is detected
java.io.IOException
- if an I/O error such as a broken
socket prevents the document from being fully read.public Document build(java.io.InputStream in, java.lang.String baseURI) throws ParsingException, ValidityException, java.io.IOException
Reads the document from an input stream while allowing a base URI to be specified.
in
- the InputStream
from which the document
is read.baseURI
- the base URI for this document
Document
ValidityException
- if a validity error is detected;
only thrown if the builder has been instructed to validate
ParsingException
- if a well-formedness error is detected
java.io.IOException
- if an I/O error such as a broken
socket prevents the document from being fully readpublic Document build(java.io.File in) throws ParsingException, ValidityException, java.io.IOException
Reads the document from a file. The base URI of the document is set to the location of the file.
in
- the File
from which the document is read
Document
ParsingException
- if a well-formedness error is detected
java.io.IOException
- if an I/O error such as a bad disk
prevents the file from being read
ValidityException
- if a validity error is detected. This
is only thrown if the builder has been instructed to validate.public Document build(java.io.Reader in) throws ParsingException, ValidityException, java.io.IOException
Reads the document from a reader.
in
- the Reader
from which the
document is read
Document
ParsingException
- if a well-formedness error is detected
java.io.IOException
- if an I/O error such as a bad disk
prevents the document from being fully read
ValidityException
- if a validity error is detected. This
is only thrown if the builder has been instructed to validate.public Document build(java.io.Reader in, java.lang.String baseURI) throws ParsingException, ValidityException, java.io.IOException
Reads the document from an input stream while allowing a base URI to be specified.
in
- the Reader
from which the document
is readbaseURI
- the base URI for this document
Document
ParsingException
- if a well-formedness error is detected
java.io.IOException
- if an I/O error such as a bad disk
prevents the document from being completely read
ValidityException
- if a validity error is detected. This
is only thrown if the builder has been instructed to validate.public Document build(java.lang.String document, java.lang.String baseURI) throws ParsingException, ValidityException, java.io.IOException
Reads the document from the contents of a String
.
document
- the String
that contains
the XML document.baseURI
- the base URI for this document.
Document
java.io.IOException
- if an I/O error such as a bad disk
prevents the document's external DTD subset from being read
ParsingException
- if a well-formedness error is detected
ValidityException
- if a validity error is detected. This
is only thrown if the builder has been instructed to
validate.public NodeFactory getNodeFactory()
If a custom NodeFactory
was passed to the
constructor, then this method returns a reference to it.
If no NodeFactory
was passed to the
constructor, then this method returns null.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |