Apache Groovy 3.0.20 · groovy.xml.DOMBuilder

Modifier and Type	Field and Description
pack-priv Document	document
pack-priv DocumentBuilder	documentBuilder

Access	Constructor and Description
public	DOMBuilder(Document document)
public	DOMBuilder(DocumentBuilder documentBuilder)

Method Summary

Modifier and Type	Method and Description
protected void	appendNamespaceAttributes(Element element, Map<Object, Object> attributes)
protected Document	createDocument()
protected Object	createNode(Object name) Implements abstract groovy.util.BuilderSupport.createNode.
protected Object	createNode(Object name, Object value) Implements abstract groovy.util.BuilderSupport.createNode.
protected Object	createNode(Object name, Map<K, V> attributes, Object value) Implements abstract groovy.util.BuilderSupport.createNode.
protected Object	createNode(Object name, Map<K, V> attributes) Implements abstract groovy.util.BuilderSupport.createNode.
public static DOMBuilder	newInstance()
public static DOMBuilder	newInstance(boolean validating, boolean namespaceAware)
public static Document	Returns: the root node of the parsed tree of Nodes parse(Reader the reader to read the XML text from reader) Creates a DocumentBuilder and uses it to parse the XML text read from the given reader.
public static Document	Returns: the root node of the parsed tree of Nodes parse(Reader the reader to read the XML text from reader, boolean whether to validate the XML validating, boolean whether the parser should be namespace aware namespaceAware) Creates a DocumentBuilder and uses it to parse the XML text read from the given reader, allowing parser validation and namespace awareness to be controlled.
public static Document	Returns: the root node of the parsed tree of Nodes parse(Reader the reader to read the XML text from reader, boolean whether to validate the XML validating, boolean whether the parser should be namespace aware namespaceAware, boolean whether the parser should allow DOCTYPE declarations allowDocTypeDeclaration) Creates a DocumentBuilder and uses it to parse the XML text read from the given reader, allowing parser validation, namespace awareness and permission of DOCTYPE declarations to be controlled.
public Document	Returns: the root node of the parsed tree of Nodes parseText(String the XML text to parse text) A helper method to parse the given text as XML.
protected void	setParent(Object parent, Object child) Implements abstract groovy.util.BuilderSupport.setParent.
private static void	setQuietly(DocumentBuilderFactory factory, String feature, boolean value)
private static void	setStringNS(Element element, Object key, Object value)

Inherited from groovy.util.BuilderSupport:: doInvokeMethod getCurrent getName invokeMethod invokeMethod nodeCompleted postNodeCompletion setClosureDelegate setCurrent

document	back to summary
pack-priv Document document

documentBuilder	back to summary
pack-priv DocumentBuilder documentBuilder

DOMBuilder	back to summary
public DOMBuilder(Document document)

DOMBuilder	back to summary
public DOMBuilder(DocumentBuilder documentBuilder)

Method Detail

appendNamespaceAttributes	back to summary
protected void appendNamespaceAttributes(Element element, Map<Object, Object> attributes)

createDocument	back to summary
protected Document createDocument()

createNode	back to summary
protected Object createNode(Object name) Implements abstract groovy.util.BuilderSupport.createNode.

createNode	back to summary
protected Object createNode(Object name, Object value) Implements abstract groovy.util.BuilderSupport.createNode.

createNode	back to summary
protected Object createNode(Object name, Map<K, V> attributes, Object value) Implements abstract groovy.util.BuilderSupport.createNode.

createNode	back to summary
protected Object createNode(Object name, Map<K, V> attributes) Implements abstract groovy.util.BuilderSupport.createNode.

newInstance	back to summary
public static DOMBuilder newInstance() throws ParserConfigurationException

newInstance	back to summary
public static DOMBuilder newInstance(boolean validating, boolean namespaceAware) throws ParserConfigurationException

parse back to summary

parse	back to summary
public static Document parse(Reader reader) throws SAXException, IOException, ParserConfigurationException Creates a DocumentBuilder and uses it to parse the XML text read from the given reader. A non-validating, namespace aware parser which does not allow DOCTYPE declarations is used. Parameters reader:Reader the reader to read the XML text from Returns:Document the root node of the parsed tree of Nodes Exceptions SAXException: Any SAX exception, possibly wrapping another exception. IOException: An IO exception from the parser, possibly from a byte stream or character stream supplied by the application. ParserConfigurationException: if a DocumentBuilder cannot be created which satisfies the configuration requested. See Also `parse(Reader, boolean, boolean)`

public static Document parse(Reader reader) throws SAXException, IOException, ParserConfigurationException

Creates a DocumentBuilder and uses it to parse the XML text read from the given reader. A non-validating, namespace aware parser which does not allow DOCTYPE declarations is used.

Parameters

reader:Reader: the reader to read the XML text from

Returns:Document

the root node of the parsed tree of Nodes

Exceptions

SAXException:: Any SAX exception, possibly wrapping another exception.
IOException:: An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.
ParserConfigurationException:: if a DocumentBuilder cannot be created which satisfies the configuration requested.

See Also

parse(Reader, boolean, boolean)

parse	back to summary
public static Document parse(Reader reader, boolean validating, boolean namespaceAware) throws SAXException, IOException, ParserConfigurationException Creates a DocumentBuilder and uses it to parse the XML text read from the given reader, allowing parser validation and namespace awareness to be controlled. Documents are not allowed to contain DOCYTYPE declarations. Parameters reader:Reader the reader to read the XML text from validating:boolean whether to validate the XML namespaceAware:boolean whether the parser should be namespace aware Returns:Document the root node of the parsed tree of Nodes Exceptions SAXException: Any SAX exception, possibly wrapping another exception. IOException: An IO exception from the parser, possibly from a byte stream or character stream supplied by the application. ParserConfigurationException: if a DocumentBuilder cannot be created which satisfies the configuration requested.

parse

back to summary

public static Document parse(Reader reader, boolean validating, boolean namespaceAware) throws SAXException, IOException, ParserConfigurationException

Creates a DocumentBuilder and uses it to parse the XML text read from the given reader, allowing parser validation and namespace awareness to be controlled. Documents are not allowed to contain DOCYTYPE declarations.

Parameters

reader:Reader: the reader to read the XML text from
validating:boolean: whether to validate the XML
namespaceAware:boolean: whether the parser should be namespace aware

Returns:Document

the root node of the parsed tree of Nodes

Exceptions

SAXException:: Any SAX exception, possibly wrapping another exception.
IOException:: An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.
ParserConfigurationException:: if a DocumentBuilder cannot be created which satisfies the configuration requested.

parse	back to summary
public static Document parse(Reader reader, boolean validating, boolean namespaceAware, boolean allowDocTypeDeclaration) throws SAXException, IOException, ParserConfigurationException Creates a DocumentBuilder and uses it to parse the XML text read from the given reader, allowing parser validation, namespace awareness and permission of DOCTYPE declarations to be controlled. Parameters reader:Reader the reader to read the XML text from validating:boolean whether to validate the XML namespaceAware:boolean whether the parser should be namespace aware allowDocTypeDeclaration:boolean whether the parser should allow DOCTYPE declarations Returns:Document the root node of the parsed tree of Nodes Exceptions SAXException: Any SAX exception, possibly wrapping another exception. IOException: An IO exception from the parser, possibly from a byte stream or character stream supplied by the application. ParserConfigurationException: if a DocumentBuilder cannot be created which satisfies the configuration requested.

parse

back to summary

public static Document parse(Reader reader, boolean validating, boolean namespaceAware, boolean allowDocTypeDeclaration) throws SAXException, IOException, ParserConfigurationException

Creates a DocumentBuilder and uses it to parse the XML text read from the given reader, allowing parser validation, namespace awareness and permission of DOCTYPE declarations to be controlled.

Parameters

reader:Reader: the reader to read the XML text from
validating:boolean: whether to validate the XML
namespaceAware:boolean: whether the parser should be namespace aware
allowDocTypeDeclaration:boolean: whether the parser should allow DOCTYPE declarations

Returns:Document

the root node of the parsed tree of Nodes

Exceptions

SAXException:: Any SAX exception, possibly wrapping another exception.
IOException:: An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.
ParserConfigurationException:: if a DocumentBuilder cannot be created which satisfies the configuration requested.

parseText back to summary

parseText	back to summary
public Document parseText(String text) throws SAXException, IOException, ParserConfigurationException A helper method to parse the given text as XML. Parameters text:String the XML text to parse Returns:Document the root node of the parsed tree of Nodes Exceptions SAXException: Any SAX exception, possibly wrapping another exception. IOException: An IO exception from the parser, possibly from a byte stream or character stream supplied by the application. ParserConfigurationException: if a DocumentBuilder cannot be created which satisfies the configuration requested. See Also `parse(Reader)`

public Document parseText(String text) throws SAXException, IOException, ParserConfigurationException

A helper method to parse the given text as XML.

Parameters

text:String: the XML text to parse

Returns:Document

the root node of the parsed tree of Nodes

Exceptions

SAXException:: Any SAX exception, possibly wrapping another exception.
IOException:: An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.
ParserConfigurationException:: if a DocumentBuilder cannot be created which satisfies the configuration requested.

See Also

parse(Reader)

setParent	back to summary
protected void setParent(Object parent, Object child) Implements abstract groovy.util.BuilderSupport.setParent.

setQuietly	back to summary
private static void setQuietly(DocumentBuilderFactory factory, String feature, boolean value)

setStringNS	back to summary
private static void setStringNS(Element element, Object key, Object value)

public Class DOMBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail