XmlSlurper (Groovy 6.0.0-SNAPSHOT)

groovy.xml.XmlSlurper

public class XmlSlurper
extends DefaultHandler

Parse XML into a document tree that may be traversed similar to XPath expressions. For example:

import groovy.xml.XmlSlurper
def rootNode = new XmlSlurper().parseText(
   '<root><one a1="uno!"/><two>Some text!</two></root>' )

assert rootNode.name() == 'root'
assert rootNode.one[0].@a1 == 'uno!'
assert rootNode.two.text() == 'Some text!'
rootNode.children().each { assert it.name() in ['one','two'] }

Note that in some cases, a 'selector' expression may not resolve to a single node. For example:

import groovy.xml.XmlSlurper
def rootNode = new XmlSlurper().parseText(
   '''<root>
        <a>one!</a>
        <a>two!</a>
      </root>''' )

assert rootNode.a.size() == 2
rootNode.a.each { assert it.text() in ['one!','two!'] }

A more realistic example — a book catalog. Given this XML:

<catalog>
  <book id="b1">
    <title>Programming Groovy 3</title>
    <author>Venkat Subramaniam</author>
    <year>2024</year>
  </book>
  <book id="b2">
    <title>Groovy in Action</title>
    <author>Dierk Koenig</author>
    <year>2015</year>
  </book>
</catalog>

the equivalent Groovy to slurp it and navigate the tree:

def catalog = new XmlSlurper().parseText(xml)
assert catalog.book.size() == 2
assert catalog.book[0].title.text() == 'Programming Groovy 3'
catalog.book.findAll { it.year.text().toInteger() >= 2020 }.each { book ->
    println "${book.title} by ${book.author}"
}

See Also:: GPathResult

Constructor Summary

Constructors
Constructor and description
`XmlSlurper()` Creates a non-validating and namespace-aware `XmlSlurper` which does not allow DOCTYPE declarations in documents.
`XmlSlurper(boolean validating, boolean namespaceAware)` Creates a `XmlSlurper` which does not allow DOCTYPE declarations in documents.
`XmlSlurper(boolean validating, boolean namespaceAware, boolean allowDocTypeDeclaration)` Creates a `XmlSlurper`.
`XmlSlurper(XMLReader reader)`
`XmlSlurper(SAXParser parser)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public void`	`characters(char[] ch, int start, int length)`
	`public void`	`endDocument()`
	`public void`	`endElement(String namespaceURI, String localName, String qName)`
	`public DTDHandler`	`getDTDHandler()`
	`public GPathResult`	`getDocument()` Returns: The GPathResult instance created by consuming a stream of SAX events Note if one of the parse methods has been called then this returns null Note if this is called more than once all calls after the first will return null
	`public EntityResolver`	`getEntityResolver()`
	`public ErrorHandler`	`getErrorHandler()`
	`public boolean`	`getFeature(String uri)`
	`public Object`	`getProperty(String uri)`
	`public void`	`ignorableWhitespace(char[] buffer, int start, int len)`
	`public boolean`	`isAllowDocTypeDeclaration()` Determine if DOCTYPE declarations are allowed.
	`public boolean`	`isKeepIgnorableWhitespace()` Returns: true if ignorable whitespace is kept
	`public boolean`	`isNamespaceAware()` Determine if namespace handling is enabled.
	`public boolean`	`isValidating()` Determine if the parser validates documents.
	`public GPathResult`	`parse(InputSource input)` Parse the content of the specified input source into a GPathResult object
	`public GPathResult`	`parse(File file)` Parses the content of the given file as XML turning it into a GPathResult object
	`public GPathResult`	`parse(InputStream input)` Parse the content of the specified input stream into an GPathResult Object.
	`public GPathResult`	`parse(Reader in)` Parse the content of the specified reader into a GPathResult Object.
	`public GPathResult`	`parse(String uri)` Parse the content of the specified URI into a GPathResult Object
	`public GPathResult`	`parse(Path path)` Parses the content of the file at the given path as XML turning it into a GPathResult object
	`public GPathResult`	`parseText(String text)` A helper method to parse the given text as XML
	`public void`	`setAllowDocTypeDeclaration(boolean allowDocTypeDeclaration)` Enable and/or disable DOCTYPE declaration support.
	`public void`	`setDTDHandler(DTDHandler dtdHandler)`
	`public void`	`setEntityBaseUrl(URL base)` Resolves entities against using the supplied URL as the base for relative URLs
	`public void`	`setEntityResolver(EntityResolver entityResolver)`
	`public void`	`setErrorHandler(ErrorHandler errorHandler)`
	`public void`	`setFeature(String uri, boolean value)`
	`public void`	`setKeepIgnorableWhitespace(boolean keepIgnorableWhitespace)` Parameters: `keepIgnorableWhitespace` - If true then ignorable whitespace (i.e. whitespace before elements) is kept.
	`public void`	`setKeepWhitespace(boolean keepWhitespace)` deprecated: use setKeepIgnorableWhitespace
	`public void`	`setNamespaceAware(boolean namespaceAware)` Enable and/or disable namespace handling.
	`public void`	`setProperty(String uri, Object value)`
	`public void`	`setValidating(boolean validating)` Enable and/or disable validation.
	`public void`	`startDocument()`
	`public void`	`startElement(String namespaceURI, String localName, String qName, Attributes atts)`
	`public void`	`startPrefixMapping(String tag, String uri)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class DefaultHandler`	`characters, declaration, endDocument, endElement, endPrefixMapping, equals, error, fatalError, getClass, hashCode, ignorableWhitespace, notationDecl, notify, notifyAll, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startElement, startPrefixMapping, toString, unparsedEntityDecl, wait, wait, wait, warning`

- Constructor Detail
  - public XmlSlurper()
    
    Creates a non-validating and namespace-aware XmlSlurper which does not allow DOCTYPE declarations in documents.
    Parser options can be configured via setters before the first parse call:
```
 // Using Groovy named parameters:
 def slurper = new XmlSlurper(namespaceAware: false, keepIgnorableWhitespace: true)
 
```
    throws:
    ParserConfigurationException if no parser which satisfies the requested configuration can be created.
    throws:
    SAXException for SAX errors.
  - public XmlSlurper(boolean validating, boolean namespaceAware)
    
    Creates a XmlSlurper which does not allow DOCTYPE declarations in documents.
    throws:
    ParserConfigurationException if no parser which satisfies the requested configuration can be created.
    throws:
    SAXException for SAX errors.
    
    Parameters:
    validating - true if the parser should validate documents as they are parsed; false otherwise.
    namespaceAware - true if the parser should provide support for XML namespaces; false otherwise.
  - public XmlSlurper(boolean validating, boolean namespaceAware, boolean allowDocTypeDeclaration)
    
    Creates a XmlSlurper.
    throws:
    ParserConfigurationException if no parser which satisfies the requested configuration can be created.
    throws:
    SAXException for SAX errors.
    
    Parameters:
    validating - true if the parser should validate documents as they are parsed; false otherwise.
    namespaceAware - true if the parser should provide support for XML namespaces; false otherwise.
    allowDocTypeDeclaration - true if the parser should provide support for DOCTYPE declarations; false otherwise.
  - public XmlSlurper(XMLReader reader)
  - public XmlSlurper(SAXParser parser)
- Method Detail
  - public void characters(char[] ch, int start, int length)
  - public void endDocument()
  - public void endElement(String namespaceURI, String localName, String qName)
  - public DTDHandler getDTDHandler()
  - public GPathResult getDocument()
    
    Returns:
    The GPathResult instance created by consuming a stream of SAX events Note if one of the parse methods has been called then this returns null Note if this is called more than once all calls after the first will return null
  - public EntityResolver getEntityResolver()
  - public ErrorHandler getErrorHandler()
  - public boolean getFeature(String uri)
  - public Object getProperty(String uri)
  - public void ignorableWhitespace(char[] buffer, int start, int len)
  - public boolean isAllowDocTypeDeclaration()
    
    Determine if DOCTYPE declarations are allowed.
    Returns:
    true if DOCTYPE declarations are allowed
    Since:
    6.0.0
  - public boolean isKeepIgnorableWhitespace()
    
    Returns:
    true if ignorable whitespace is kept
  - public boolean isNamespaceAware()
    
    Determine if namespace handling is enabled.
    Returns:
    true if namespace handling is enabled
  - public boolean isValidating()
    
    Determine if the parser validates documents.
    Returns:
    true if validation is enabled
    Since:
    6.0.0
  - public GPathResult parse(InputSource input)
    
    Parse the content of the specified input source into a GPathResult object
    throws:
    SAXException Any SAX exception, possibly wrapping another exception.
    throws:
    IOException An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.
    
    Parameters:
    input - the InputSource to parse
    Returns:
    An object which supports GPath expressions
  - public GPathResult parse(File file)
    
    Parses the content of the given file as XML turning it into a GPathResult object
    throws:
    SAXException Any SAX exception, possibly wrapping another exception.
    throws:
    IOException An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.
    
    Parameters:
    file - the File to parse
    Returns:
    An object which supports GPath expressions
  - public GPathResult parse(InputStream input)
    
    Parse the content of the specified input stream into an GPathResult Object. Note that using this method will not provide the parser with any URI for which to find DTDs etc. It is up to you to close the InputStream after parsing is complete (if required).
    throws:
    SAXException Any SAX exception, possibly wrapping another exception.
    throws:
    IOException An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.
    
    Parameters:
    input - the InputStream to parse
    Returns:
    An object which supports GPath expressions
  - public GPathResult parse(Reader in)
    
    Parse the content of the specified reader into a GPathResult Object. Note that using this method will not provide the parser with any URI for which to find DTDs etc. It is up to you to close the Reader after parsing is complete (if required).
    throws:
    SAXException Any SAX exception, possibly wrapping another exception.
    throws:
    IOException An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.
    
    Parameters:
    in - the Reader to parse
    Returns:
    An object which supports GPath expressions
  - public GPathResult parse(String uri)
    
    Parse the content of the specified URI into a GPathResult Object
    throws:
    SAXException Any SAX exception, possibly wrapping another exception.
    throws:
    IOException An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.
    
    Parameters:
    uri - a String containing the URI to parse
    Returns:
    An object which supports GPath expressions
  - public GPathResult parse(Path path)
    
    Parses the content of the file at the given path as XML turning it into a GPathResult object
    throws:
    SAXException Any SAX exception, possibly wrapping another exception.
    throws:
    IOException An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.
    
    Parameters:
    path - the path of the File to parse
    Returns:
    An object which supports GPath expressions
  - public GPathResult parseText(String text)
    
    A helper method to parse the given text as XML
    throws:
    SAXException Any SAX exception, possibly wrapping another exception.
    throws:
    IOException An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.
    
    Parameters:
    text - a String containing XML to parse
    Returns:
    An object which supports GPath expressions
  - public void setAllowDocTypeDeclaration(boolean allowDocTypeDeclaration)
    
    Enable and/or disable DOCTYPE declaration support. Must be set before the first parse call.
    throws:
    IllegalStateException if called after parsing has started
    
    Parameters:
    allowDocTypeDeclaration - the new desired value
    Since:
    6.0.0
  - public void setDTDHandler(DTDHandler dtdHandler)
  - public void setEntityBaseUrl(URL base)
    
    Resolves entities against using the supplied URL as the base for relative URLs
    Parameters:
    base - The URL used to resolve relative URLs
  - public void setEntityResolver(EntityResolver entityResolver)
  - public void setErrorHandler(ErrorHandler errorHandler)
  - public void setFeature(String uri, boolean value)
  - public void setKeepIgnorableWhitespace(boolean keepIgnorableWhitespace)
    
    Parameters:
    keepIgnorableWhitespace - If true then ignorable whitespace (i.e. whitespace before elements) is kept. The default is to discard the whitespace.
  - @Deprecated
    public void setKeepWhitespace(boolean keepWhitespace)
    
    deprecated:
    use setKeepIgnorableWhitespace
    
    Parameters:
    keepWhitespace - If true then whitespace before elements is kept. The default is to discard the whitespace.
  - public void setNamespaceAware(boolean namespaceAware)
    
    Enable and/or disable namespace handling. Must be set before the first parse call.
    throws:
    IllegalStateException if called after parsing has started
    
    Parameters:
    namespaceAware - the new desired value
    Since:
    6.0.0
  - public void setProperty(String uri, Object value)
  - public void setValidating(boolean validating)
    
    Enable and/or disable validation. Must be set before the first parse call.
    throws:
    IllegalStateException if called after parsing has started
    
    Parameters:
    validating - the new desired value
    Since:
    6.0.0
  - public void startDocument()
  - public void startElement(String namespaceURI, String localName, String qName, Attributes atts)
  - public void startPrefixMapping(String tag, String uri)

Summary:
Constructor
Method

| Detail:
Constructor
Method

[Java] Class XmlSlurper

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

public XmlSlurper()

public XmlSlurper(boolean validating, boolean namespaceAware)

public XmlSlurper(boolean validating, boolean namespaceAware, boolean allowDocTypeDeclaration)

public XmlSlurper(XMLReader reader)

public XmlSlurper(SAXParser parser)

Method Detail

public void characters(char[] ch, int start, int length)

public void endDocument()

public void endElement(String namespaceURI, String localName, String qName)

public DTDHandler getDTDHandler()

public GPathResult getDocument()

public EntityResolver getEntityResolver()

public ErrorHandler getErrorHandler()

public boolean getFeature(String uri)

public Object getProperty(String uri)

public void ignorableWhitespace(char[] buffer, int start, int len)

public boolean isAllowDocTypeDeclaration()

public boolean isKeepIgnorableWhitespace()

public boolean isNamespaceAware()

public boolean isValidating()

public GPathResult parse(InputSource input)

public GPathResult parse(File file)

public GPathResult parse(InputStream input)

public GPathResult parse(Reader in)

public GPathResult parse(String uri)

public GPathResult parse(Path path)

public GPathResult parseText(String text)

public void setAllowDocTypeDeclaration(boolean allowDocTypeDeclaration)

public void setDTDHandler(DTDHandler dtdHandler)

public void setEntityBaseUrl(URL base)

public void setEntityResolver(EntityResolver entityResolver)

public void setErrorHandler(ErrorHandler errorHandler)

public void setFeature(String uri, boolean value)

public void setKeepIgnorableWhitespace(boolean keepIgnorableWhitespace)

@Deprecatedpublic void setKeepWhitespace(boolean keepWhitespace)

public void setNamespaceAware(boolean namespaceAware)

public void setProperty(String uri, Object value)

public void setValidating(boolean validating)

public void startDocument()

public void startElement(String namespaceURI, String localName, String qName, Attributes atts)

public void startPrefixMapping(String tag, String uri)

@Deprecated
public void setKeepWhitespace(boolean keepWhitespace)