java.lang.Object
- net.jodah.xsylum.XmlSearchable<Element>
- - net.jodah.xsylum.XmlElement

public final class XmlElement
extends XmlSearchable<Element>

A named XML element.

Field Summary
- Fields inherited from class net.jodah.xsylum.XmlSearchable
  source

Constructor Summary

Constructors
Constructor Description

XmlElement(Element element)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`attribute(String attribute)`	Get the value of the `attribute`.
`boolean`	`attributeAsBoolean(String attribute)`	Get the value of the `attribute` as a boolean.
`double`	`attributeAsDouble(String attribute)`	Get the value of the `attribute` as a double.
`<V extends Enum<V>> V`	`attributeAsEnum(String attribute, Class<V> targetEnum)`	Get the value of the `attribute` as an enum of type `V`.
`int`	`attributeAsInt(String attribute)`	Get the value of the `attribute` as an integer.
`long`	`attributeAsLong(String attribute)`	Get the value of the `attribute` as a long.
`Map<String,String>`	`attributes()`	Builds and returns a map of the element's attributes, else empty map if the element has no attributes.
`List<XmlElement>`	`children()`	Returns the element's children, else empty list if the element has no children.
`Element`	`element()`	Returns the underlying element.
`XmlElement`	`get(int index)`	Returns the XmlElement at the `index`, else null if none can be found or the node at the `index` is not an element
`XmlElement`	`get(String tagName)`	Returns the first child XmlElement matching the `tagName`.
`List<XmlElement>`	`getAll(String tagName)`	Returns all child XmlElements matching the `tagName`.
`boolean`	`hasAttribute(String attribute)`	Returns whether the element contains the `attribute`.
`boolean`	`hasAttributes()`	Returns whether the element contains attributes.
`boolean`	`hasChild(String name)`	Returns whether the element contains any child elements with the `name`.
`String`	`name()`	Returns the element's name.
`String`	`toString()`
`String`	`toXml()`	Returns a XML representation of the element, including its attributes and value.
`String`	`value()`	Returns the text value of the element.
`boolean`	`valueAsBoolean()`	Get the element value as a boolean.
`double`	`valueAsDouble()`	Get the element value as a double.
`<V extends Enum<V>> V`	`valueAsEnum(Class<V> targetEnum)`	Get the element value as an enum of type `V`.
`int`	`valueAsInt()`	Get the element value as an integer.
`long`	`valueAsLong()`	Get the element value as a long.

Methods inherited from class net.jodah.xsylum.XmlSearchable
find, findAll, value, valueAsBoolean, valueAsDouble, valueAsEnum, valueAsInt, valueAsLong, values, valuesAsBoolean, valuesAsDouble, valuesAsEnum, valuesAsInt, valuesAsLong

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - XmlElement
```
public XmlElement(Element element)
```
- Method Detail
  - attribute
```
public String attribute(String attribute)
                 throws XsylumException
```
    Get the value of the attribute.
    
    Throws:
    
    XsylumException - if the attribute cannot be found
  - attributeAsBoolean
```
public boolean attributeAsBoolean(String attribute)
                           throws XsylumException
```
    Get the value of the attribute as a boolean. Returns true for "true", "1", "yes", "y" ignoring case, else returns false.
    
    Throws:
    
    XsylumException - if the attribute cannot be found
  - attributeAsDouble
```
public double attributeAsDouble(String attribute)
                         throws XsylumException
```
    Get the value of the attribute as a double.
    
    Throws:
    
    XsylumException - if the attribute cannot be found
    
    NumberFormatException - if the attribute is not a valid double
  - attributeAsEnum
```
public <V extends Enum<V>> V attributeAsEnum(String attribute,
                                             Class<V> targetEnum)
                                      throws XsylumException
```
    Get the value of the attribute as an enum of type V. Returns null if value cannot be parsed to an enum of type V.
    
    Type Parameters:
    
    V - enum type
    
    Throws:
    
    XsylumException - if the attribute cannot be found
  - attributeAsInt
```
public int attributeAsInt(String attribute)
                   throws XsylumException
```
    Get the value of the attribute as an integer.
    
    Throws:
    
    XsylumException - if the attribute cannot be found
    
    NumberFormatException - if the attribute is not a valid int
  - attributeAsLong
```
public long attributeAsLong(String attribute)
                     throws XsylumException
```
    Get the value of the attribute as a long.
    
    Throws:
    
    XsylumException - if the attribute cannot be found
    
    NumberFormatException - if the attribute is not a valid long
  - attributes
```
public Map<String,String> attributes()
```
    Builds and returns a map of the element's attributes, else empty map if the element has no attributes.
  - children
```
public List<XmlElement> children()
```
    Returns the element's children, else empty list if the element has no children.
  - element
```
public Element element()
```
    Returns the underlying element.
  - get
```
public XmlElement get(int index)
```
    Returns the XmlElement at the index, else null if none can be found or the node at the index is not an element
  - get
```
public XmlElement get(String tagName)
```
    Returns the first child XmlElement matching the tagName.
    
    Specified by:
    
    get in class XmlSearchable<Element>
  - getAll
```
public List<XmlElement> getAll(String tagName)
```
    Returns all child XmlElements matching the tagName.
    
    Specified by:
    
    getAll in class XmlSearchable<Element>
  - hasAttribute
```
public boolean hasAttribute(String attribute)
```
    Returns whether the element contains the attribute.
  - hasAttributes
```
public boolean hasAttributes()
```
    Returns whether the element contains attributes.
  - hasChild
```
public boolean hasChild(String name)
```
    Returns whether the element contains any child elements with the name.
  - name
```
public String name()
```
    Returns the element's name.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toXml
```
public String toXml()
```
    Returns a XML representation of the element, including its attributes and value.
  - value
```
public String value()
```
    Returns the text value of the element.
  - valueAsBoolean
```
public boolean valueAsBoolean()
```
    Get the element value as a boolean. Returns true for "true", "1", "yes", "y" ignoring case, else returns false.
  - valueAsDouble
```
public double valueAsDouble()
```
    Get the element value as a double.
    
    Throws:
    
    NumberFormatException - if the value is not a valid double
  - valueAsEnum
```
public <V extends Enum<V>> V valueAsEnum(Class<V> targetEnum)
```
    Get the element value as an enum of type V. Returns null if value cannot be parsed to an enum of type V.
    
    Type Parameters:
    
    V - enum type
  - valueAsInt
```
public int valueAsInt()
```
    Get the element value as an integer.
    
    Throws:
    
    NumberFormatException - if the value is not a valid int
  - valueAsLong
```
public long valueAsLong()
```
    Get the element value as a long.
    
    Throws:
    
    NumberFormatException - if the value is not a valid long

Class XmlElement

Field Summary

Fields inherited from class net.jodah.xsylum.XmlSearchable

Constructor Summary

Method Summary

Methods inherited from class net.jodah.xsylum.XmlSearchable

Methods inherited from class java.lang.Object

Constructor Detail

XmlElement

Method Detail

attribute

attributeAsBoolean

attributeAsDouble

attributeAsEnum

attributeAsInt

attributeAsLong

attributes

children

element

get

get

getAll

hasAttribute

hasAttributes

hasChild

name

toString

toXml

value

valueAsBoolean

valueAsDouble

valueAsEnum

valueAsInt

valueAsLong