Package groovy.xml.slurpersupport
Class GPathResult
java.lang.Object
groovy.lang.GroovyObjectSupport
groovy.xml.slurpersupport.GPathResult
- All Implemented Interfaces:
- Buildable,- GroovyObject,- Writable,- Iterable
- Direct Known Subclasses:
- Attribute,- NoChildren,- NodeChild,- NodeChildren
public abstract class GPathResult
extends GroovyObjectSupport
implements Writable, Buildable, Iterable
Base class for representing lazy evaluated GPath expressions.
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected final Stringprotected final Mapprotected final Stringprotected final GPathResult
- 
Constructor SummaryConstructorsConstructorDescriptionGPathResult(GPathResult parent, String name, String namespacePrefix, Map<String, String> namespaceTagHints) Creates a new GPathResult namednamewith the parentparent, the namespacePrefixnamespacePrefixand the namespaceTagHints specified in thenamespaceTagHintsMap.
- 
Method SummaryModifier and TypeMethodDescriptionprotected abstract voidappendNode(Object newValue) Provides an Iterator over all the nodes of this GPathResult using a breadth-first traversal.abstract IteratorReturns an iterator over the child nodes of this GPathResult.children()Returns the children of this GPathResult as a GPathResult object.protected IteratorcreateIterator(Object obj) declareNamespace(Map newNamespaceMapping) Adds the specified map of prefix to namespace mappings to this GPathResult.Provides an Iterator over all the nodes of this GPathResult using a depth-first traversal.booleanabstract GPathResultReturns the first child of this GPathResult matching the condition(s) specified in the passed closure.abstract GPathResultReturns the children of this GPathResult matching the condition(s) specified in the passed closure.getAt(int index) Supports the subscript operator for a GPathResult.Supports the range subscript operator for a GPathResult.getBody()Creates a Closure representing the body of this GPathResult.getProperty(String property) Returns the specified Property of this GPathResult.inthashCode()booleanisEmpty()Returns true if the GPathResult is empty, i.e.abstract Iteratoriterator()Overloads the left shift operator to provide an easy way to lazily append Objects to this GPathResult.list()Creates a list of objects representing this GPathResult.lookupNamespace(String prefix) Returns the namespace mapped to the specified prefix.name()Returns the name of this GPathResult.abstract Iteratorparent()Returns as GPathResult with the parent nodes of the current GPathResultabstract GPathResultparents()Returns the parents of this GPathResult as aGPathResult.Lazily adds the specified Object to this GPathResult.pop()Returns the parent of this GPathResult.voidA helper method to allow GPathResults to work with subscript operatorsprotected abstract voidreplaceBody(Object newValue) protected abstract voidreplaceNode(Closure newValue) voidsetMetaClass(MetaClass metaClass) Replaces the MetaClass of this GPathResult.voidsetProperty(String property, Object newValue) Replaces the specified property of this GPathResult with a new value.abstract intsize()Returns the size of this GPathResult.abstract Stringtext()Returns the text of this GPathResult as aString.Converts the text of this GPathResult to a BigDecimal object.Converts the text of this GPathResult to a BigInteger object.Converts the text of this GPathResult to a Boolean object.toDouble()Converts the text of this GPathResult to a Double object.toFloat()Converts the text of this GPathResult to a Float object.Converts the text of this GPathResult to an Integer object.toLong()Converts the text of this GPathResult to a Long object.toString()Returns the text of this GPathResult.toURI()Converts the text of this GPathResult to a URI object.toURL()Converts the text of this GPathResult to a URL object.Methods inherited from class groovy.lang.GroovyObjectSupportgetMetaClassMethods inherited from class java.lang.Objectclone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface groovy.lang.GroovyObjectinvokeMethodMethods inherited from interface java.lang.IterableforEach, spliterator
- 
Field Details- 
parent
- 
name
- 
namespacePrefix
- 
namespaceMap
- 
namespaceTagHints
 
- 
- 
Constructor Details- 
GPathResultpublic GPathResult(GPathResult parent, String name, String namespacePrefix, Map<String, String> namespaceTagHints) Creates a new GPathResult namednamewith the parentparent, the namespacePrefixnamespacePrefixand the namespaceTagHints specified in thenamespaceTagHintsMap.- Parameters:
- parent- the GPathResult prior to the application of the expression creating this GPathResult
- name- if the GPathResult corresponds to something with a name, e.g. a node
- namespacePrefix- the namespace prefix if any
- namespaceTagHints- the known tag to namespace mappings
 
 
- 
- 
Method Details- 
setMetaClassReplaces the MetaClass of this GPathResult.- Specified by:
- setMetaClassin interface- GroovyObject
- Overrides:
- setMetaClassin class- GroovyObjectSupport
- Parameters:
- metaClass- the new MetaClass
 
- 
getPropertyReturns the specified Property of this GPathResult.Realizes the follow shortcuts: - '..'for- parent()
- '*'for- children()
- '**'for- depthFirst()
- '@'for attribute access
 - Specified by:
- getPropertyin interface- GroovyObject
- Parameters:
- property- the Property to fetch
- Returns:
- the given property
 
- 
setPropertyReplaces the specified property of this GPathResult with a new value.- Specified by:
- setPropertyin interface- GroovyObject
- Parameters:
- property- the property of this GPathResult to replace
- newValue- the new value of the property
 
- 
leftShiftOverloads the left shift operator to provide an easy way to lazily append Objects to this GPathResult.- Parameters:
- newValue- the Object to append
- Returns:
- this
 
- 
plusLazily adds the specified Object to this GPathResult.- Parameters:
- newValue- the Object to add
- Returns:
- this
 
- 
plus
- 
replaceNode
- 
replaceBody
- 
appendNode
- 
nameReturns the name of this GPathResult.- Returns:
- the name of this GPathResult
 
- 
popReturns the parent of this GPathResult. If this GPathResult has no parent the GPathResult itself is returned. This is no navigation in the XML tree. It is backtracking on the GPath expression chain. It is the behavior of parent() prior to 2.2.0. Backtracking on '..' actually goes down one level in the tree again. find() and findAll() are popped along with the level they have been applied to.- Returns:
- the parent or this
 
- 
parentReturns as GPathResult with the parent nodes of the current GPathResult- Returns:
- the parents GPathResult or thisfor the root
 
- 
childrenReturns the children of this GPathResult as a GPathResult object.- Returns:
- the children of this GPathResult
 
- 
lookupNamespaceReturns the namespace mapped to the specified prefix.- Parameters:
- prefix- the prefix lookup
- Returns:
- the namespace of the prefix
 
- 
toStringReturns the text of this GPathResult.
- 
toIntegerConverts the text of this GPathResult to an Integer object.- Returns:
- the GPathResult, converted to a Integer
 
- 
toLongConverts the text of this GPathResult to a Long object.- Returns:
- the GPathResult, converted to a Long
 
- 
toFloatConverts the text of this GPathResult to a Float object.- Returns:
- the GPathResult, converted to a Float
 
- 
toDoubleConverts the text of this GPathResult to a Double object.- Returns:
- the GPathResult, converted to a Double
 
- 
toBigDecimalConverts the text of this GPathResult to a BigDecimal object.- Returns:
- the GPathResult, converted to a BigDecimal
 
- 
toBigIntegerConverts the text of this GPathResult to a BigInteger object.- Returns:
- the GPathResult, converted to a BigInteger
 
- 
toURLConverts the text of this GPathResult to a URL object.- Returns:
- the GPathResult, converted to a URL
- Throws:
- MalformedURLException
 
- 
toURIConverts the text of this GPathResult to a URI object.- Returns:
- the GPathResult, converted to a URI
- Throws:
- URISyntaxException
 
- 
toBooleanConverts the text of this GPathResult to a Boolean object.- Returns:
- the GPathResult, converted to a Boolean
 
- 
declareNamespaceAdds the specified map of prefix to namespace mappings to this GPathResult. Already existing prefixes are overwritten.- Parameters:
- newNamespaceMapping- the mappings to add
- Returns:
- this
 
- 
hashCodepublic int hashCode()
- 
equals
- 
getAtSupports the subscript operator for a GPathResult.import groovy.xml.slurpersupport.* import groovy.xml.XmlSlurper def text = """ <characterList> <character/> <character> <name>Gromit</name> </character> </characterList>""" GPathResult characterList = new XmlSlurper().parseText(text) assert characterList.character[1].name == 'Gromit'- Parameters:
- index- an index
- Returns:
- the value at the given index
 
- 
getAtSupports the range subscript operator for a GPathResult.import groovy.xml.slurpersupport.* import groovy.xml.XmlSlurper def text = """ <characterList> <character>Wallace</character> <character>Gromit</character> <character>Shaun</character> </characterList>""" GPathResult characterList = new XmlSlurper().parseText(text) assert characterList.character[1..2].join(',') == 'Gromit,Shaun'- Parameters:
- range- a Range indicating the items to get
- Returns:
- a new list based on range borders
 
- 
putAtA helper method to allow GPathResults to work with subscript operators- Parameters:
- index- an index
- newValue- the value to put at the given index
 
- 
depthFirstProvides an Iterator over all the nodes of this GPathResult using a depth-first traversal.- Returns:
- the Iteratorof (depth-first) ordered GPathResults
 
- 
breadthFirstProvides an Iterator over all the nodes of this GPathResult using a breadth-first traversal.- Returns:
- the Iteratorof (breadth-first) ordered GPathResults
 
- 
listCreates a list of objects representing this GPathResult.- Returns:
- a list representing of this GPathResult
 
- 
isEmptypublic boolean isEmpty()Returns true if the GPathResult is empty, i.e. if, and only if,size()is 0.- Returns:
- true if the GPathResult is empty
 
- 
getBodyCreates a Closure representing the body of this GPathResult.- Returns:
- the body of this GPathResult, converted to a Closure
 
- 
sizepublic abstract int size()Returns the size of this GPathResult.- Returns:
- the size of this GPathResult
 
- 
textReturns the text of this GPathResult as aString.- Returns:
- the text of this GPathResult
 
- 
parentsReturns the parents of this GPathResult as aGPathResult. Warning: The subclasses of this package do not implement this method yet.- Returns:
- the parents of this GPathResult
 
- 
childNodesReturns an iterator over the child nodes of this GPathResult.- Returns:
- an iterator over the child nodes of this GPathResult
 
- 
iterator
- 
findReturns the first child of this GPathResult matching the condition(s) specified in the passed closure.- Parameters:
- closure- a closure to filters the children of this GPathResult
- Returns:
- the first child matching the closure
 
- 
findAllReturns the children of this GPathResult matching the condition(s) specified in the passed closure.- Parameters:
- closure- a closure to filters the children of this GPathResult
- Returns:
- the children matching the closure
 
- 
nodeIterator
- 
createIterator
 
-