org.rvpf.base.xml

Class XMLDocument

Object

XMLDocument

All Implemented Interfaces:

XMLElement.Factory

@NotThreadSafe
public final class XMLDocument
extends Object
implements XMLElement.Factory

XML document.

Instances of this class are not thread safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XMLDocument.ElementReader Element reader.
static class	XMLDocument.ParseException Parse exception.
static interface	XMLDocument.PIHandler Processing instruction handler.

Constructor Summary

Constructors

Constructor and Description
XMLDocument() Constructs an instance.
XMLDocument(String name) Constructs an instance.
XMLDocument(XMLElement rootElement) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
XMLElement	createXMLElement(String name) Creates a new element.
XMLElement.Factory	getElementFactory() Gets the element factory.
XMLElement	getRootElement() Gets the root element.
static XMLDocument	load(File file) Loads an XML document from a file.
static XMLDocument	load(URL url, Optional<String> encoding) Loads an XML document from a URL.
XMLElement	newXMLElement(String name) Returns a new element.
XMLElement	parse(File file, Optional<String> encoding) Parses XML from a file.
XMLElement	parse(InputStream inputStream, Optional<String> encoding) Parses XML from an input stream.
XMLElement	parse(Reader reader) Parses XML from a reader.
XMLElement	parse(String string) Parses XML from a string.
XMLElement	parse(URL url, Optional<String> encoding) Parses XML from an URL.
void	setDefaultHandler(Optional<XMLElement.Handler> handler) Sets the default handler.
void	setDocTypeStrings(Optional<String> publicString, Optional<String> systemString) Sets the document type strings.
void	setDocTypeStrings(String[] strings) Sets the document type strings.
void	setElementFactory(XMLElement.Factory elementFactory) Sets the element factory.
void	setElementHandler(String elementPath, Optional<XMLElement.Handler> handler) Sets an element handler.
void	setPIHandler(Optional<XMLDocument.PIHandler> piHandler) Sets the processing instruction handler.
void	setRootElement(Optional<XMLElement> rootElement) Sets the root element.
void	setRootElement(String name) Sets the root element.
void	setRootHandler(Optional<XMLElement.Handler> handler) Sets the root handler.
void	setValidating(boolean validating) Sets the validating indicator.
void	setXMLReader(Optional<XMLReader> xmlReader) Sets the XML reader.
String	toString()
String	toXML(Optional<String> encoding, boolean indented) Returns this as a XML string.
void	toXML(Optional<String> encoding, boolean indented, Appendable destination) Converts this to XML.

Methods inherited from class Object

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

Constructor Detail

XMLDocument

public XMLDocument()

Constructs an instance.

XMLDocument

public XMLDocument(@Nonnull
                   String name)

Constructs an instance.

Parameters:

name - The root element's name.

XMLDocument

public XMLDocument(@Nonnull
                   XMLElement rootElement)

Constructs an instance.

Parameters:

rootElement - The root element.

Method Detail

load

@Nullable
 @CheckReturnValue
public static XMLDocument load(@Nonnull
                                                              File file)

Loads an XML document from a file.

Parameters:

file - The file.

Returns:

The XML document (null on failure).

load

@Nullable
 @CheckReturnValue
public static XMLDocument load(@Nonnull
                                                              URL url,
                                                              @Nonnull
                                                              Optional<String> encoding)

Loads an XML document from a URL.

Parameters:

url - The URL.

encoding - The optional character encoding name.

Returns:

The XML document (null on failure).

createXMLElement

@Nonnull
 @CheckReturnValue
public XMLElement createXMLElement(@Nonnull
                                                                 String name)

Creates a new element.

Parameters:

name - The element's name.

Returns:

The element.

getElementFactory

@Nonnull
 @CheckReturnValue
public XMLElement.Factory getElementFactory()

Gets the element factory.

Returns:

The element factory.

getRootElement

@Nonnull
 @CheckReturnValue
public XMLElement getRootElement()

Gets the root element.

Returns:

The root element.

newXMLElement

@Nonnull
 @CheckReturnValue
public XMLElement newXMLElement(@Nonnull
                                                              String name)

Returns a new element.

Specified by:

newXMLElement in interface XMLElement.Factory

Parameters:

name - The element's name.

Returns:

The element.

parse

@Nonnull
public XMLElement parse(@Nonnull
                                  Reader reader)
                           throws XMLDocument.ParseException

Parses XML from a reader.

Parameters:

reader - A reader for the XML text.

Returns:

The root element.

Throws:

XMLDocument.ParseException - When appropriate.

parse

@Nonnull
public XMLElement parse(@Nonnull
                                  String string)
                           throws XMLDocument.ParseException

Parses XML from a string.

Parameters:

string - The XML string.

Returns:

The root element.

Throws:

XMLDocument.ParseException - When appropriate.

parse

@Nonnull
public XMLElement parse(@Nonnull
                                  File file,
                                  @Nonnull
                                  Optional<String> encoding)
                           throws XMLDocument.ParseException

Parses XML from a file.

Parameters:

file - The XML file.

encoding - The optional character encoding name.

Returns:

The root element.

Throws:

XMLDocument.ParseException - When appropriate.

parse

@Nonnull
public XMLElement parse(@Nonnull
                                  InputStream inputStream,
                                  @Nonnull
                                  Optional<String> encoding)
                           throws XMLDocument.ParseException

Parses XML from an input stream.

Parameters:

inputStream - An input stream for the XML text.

encoding - The optional character encoding name.

Returns:

The root element.

Throws:

XMLDocument.ParseException - When appropriate.

parse

@Nonnull
public XMLElement parse(@Nonnull
                                  URL url,
                                  @Nonnull
                                  Optional<String> encoding)
                           throws XMLDocument.ParseException

Parses XML from an URL.

Parameters:

url - The URL of the XML text.

encoding - The character encoding name (may be empty).

Returns:

The root element.

Throws:

XMLDocument.ParseException - When appropriate.

setDefaultHandler

public void setDefaultHandler(@Nonnull
                              Optional<XMLElement.Handler> handler)

Sets the default handler.

Parameters:

handler - The default handler.

setDocTypeStrings

public void setDocTypeStrings(@Nonnull
                              String[] strings)

Sets the document type strings.

Parameters:

strings - An array holding the public and system strings.

setDocTypeStrings

public void setDocTypeStrings(@Nonnull
                              Optional<String> publicString,
                              @Nonnull
                              Optional<String> systemString)

Sets the document type strings.

Parameters:

publicString - The optional public string.

systemString - The optional system string.

setElementFactory

public void setElementFactory(@Nonnull
                              XMLElement.Factory elementFactory)

Sets the element factory.

Parameters:

elementFactory - The element factory.

setElementHandler

public void setElementHandler(@Nonnull
                              String elementPath,
                              @Nonnull
                              Optional<XMLElement.Handler> handler)

Sets an element handler.

Parameters:

elementPath - The element path.

handler - The element handler (empty means remove).

setPIHandler

public void setPIHandler(@Nonnull
                         Optional<XMLDocument.PIHandler> piHandler)

Sets the processing instruction handler.

Parameters:

piHandler - The optional processing instruction handler.

setRootElement

public void setRootElement(@Nonnull
                           Optional<XMLElement> rootElement)

Sets the root element.

Parameters:

rootElement - The root element.

setRootElement

public void setRootElement(@Nonnull
                           String name)

Sets the root element.

Parameters:

name - The root element's name.

setRootHandler

public void setRootHandler(@Nonnull
                           Optional<XMLElement.Handler> handler)

Sets the root handler.

Parameters:

handler - The optional root handler.

setValidating

public void setValidating(boolean validating)

Sets the validating indicator.

Parameters:

validating - The validating indicator.

setXMLReader

public void setXMLReader(@Nonnull
                         Optional<XMLReader> xmlReader)

Sets the XML reader.

Parameters:

xmlReader - The optional XML reader.

toString

public String toString()

Overrides:

toString in class Object

toXML

@Nonnull
 @CheckReturnValue
public String toXML(@Nonnull
                                                  Optional<String> encoding,
                                                  boolean indented)

Returns this as a XML string.

Parameters:

encoding - The optional encoding identification for the XML header.

indented - True requests indented output.

Returns:

The XML string.

toXML

public void toXML(@Nonnull
                  Optional<String> encoding,
                  boolean indented,
                  @Nonnull
                  Appendable destination)
           throws IOException

Converts this to XML.

Parameters:

encoding - The optional encoding identification for the XML header.

indented - True requests indented output.

destination - The destination.

Throws:

IOException - From the destination.