Element (Stringflow Java SDK 2.0.0 API)

java.lang.Object
- abs.ixi.client.xml.Element

All Implemented Interfaces:

XMLNode, Serializable, Cloneable
```
public class Element
extends Object
implements XMLNode
```
This extremely simple implementation for XML element. It does not support many features offered in XML specification for an implement. However it is good enough to handle XMPP Stanza elements.
Currently this does not support CDataSection

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected LinkedList<Pair<String,String>>`	`attributes`
`protected LinkedList<XMLNode>`	`children`
`protected String`	`defxmlns`
`protected String`	`name`
`protected String`	`xmlns`

Constructor Summary

Constructors
Constructor and Description
`Element(Element element)` Performs a deep copy on the supplied element and populates instance variable of this instance.
`Element(String name)` Creates a blank element with the name given
`Element(String name, String text)` Creates a simple element with given and name and text value
`Element(String name, StringBuilder[] attributeName, StringBuilder[] attributeValues)` Public Constructor to instantiate Element

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAttribute(String attName, String attValue)`
`void`	`addAttributes(Map<String,String> attrs)`
`void`	`addCDATASection(String cdata)` Adds `CDataSection` node in the children of this element
`void`	`addChild(XMLNode child)`
`void`	`addChildren(List<Element> children)`
`void`	`addText(String text)` Adds text node in the children of this element.
`void`	`addText(String text, boolean removeExiting)` adds `Text` node to this element children.
`int`	`children()` Returns number of children for this node.
`Element`	`clone()` makes a deep copy of this XML Node and returns it
`boolean`	`equals(Object obj)`
`Element`	`findChild(String[] elemPath)`
`<R> List<R>`	`flatMapChildren(Function<Element,Collection<? extends R>> mapper)`
`void`	`forEachChild(Consumer<Element> consumer)`
`String`	`getAttribute(String attName)` Returns value for the supplied attribute.
`List<Pair<String,String>>`	`getAttributes()` Returns attributes for this element.
`Element`	`getChild(String name)`
`Element`	`getChild(String name, String child_xmlns)`
`String`	`getChildAttribute(String childName, String attName)`
`List<Element>`	`getChildren()`
`List<Element>`	`getChildren(String[] elementPath)`
`Element`	`getChildStaticStr(String name)`
`String`	`getName()`
`String`	`getXMLNS()`
`String`	`getXMLNS(String[] elementPath)`
`void`	`removeAttribute(String key)`
`boolean`	`removeChild(Element child)`
`void`	`removeText()` Removes `Text` nodes and `CDataSection` nodes from the children of this element
`void`	`setAttribute(String key, String value)`
`void`	`setChildren(List<XMLNode> children)`
`void`	`setDefXMLNS(String ns)`
`void`	`setName(String argName)`
`void`	`setXMLNS(String ns)`
`String`	`stringify()` Returns XML representation of this XML node
`String`	`stringifyChildren()` Returns XML string with all the children nodes of this node
`String`	`toString()`
`String`	`val()` Returns concatenated String of `Text` and `CDataSection` nodes in the children.

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

- Field Detail
  - name
```
protected String name
```
  - defxmlns
```
protected String defxmlns
```
  - xmlns
```
protected String xmlns
```
  - children
```
protected LinkedList<XMLNode> children
```
  - attributes
```
protected LinkedList<Pair<String,String>> attributes
```
- Constructor Detail
  - Element
```
public Element(String name)
```
    Creates a blank element with the name given
    
    Parameters:
    
    name - element name
  - Element
```
public Element(String name,
               String text)
```
    Creates a simple element with given and name and text value
    
    Parameters:
    
    name - element name
    
    text - string value of the element
  - Element
```
public Element(String name,
               StringBuilder[] attributeName,
               StringBuilder[] attributeValues)
```
    Public Constructor to instantiate Element
    
    Parameters:
    
    name - name of the element
    
    attributeName - array of attribute names
    
    attributeValues - array of attribute values
  - Element
```
public Element(Element element)
```
    Performs a deep copy on the supplied element and populates instance variable of this instance.
    
    Parameters:
    
    element - element isntance from which this element will be cloned
- Method Detail
  - addAttribute
```
public void addAttribute(String attName,
                         String attValue)
```
  - addAttributes
```
public void addAttributes(Map<String,String> attrs)
```
  - addChild
```
public void addChild(XMLNode child)
```
  - addChildren
```
public void addChildren(List<Element> children)
```
  - findChild
```
public Element findChild(String[] elemPath)
```
  - flatMapChildren
```
public <R> List<R> flatMapChildren(Function<Element,Collection<? extends R>> mapper)
```
  - forEachChild
```
public void forEachChild(Consumer<Element> consumer)
```
  - getChildAttribute
```
public String getChildAttribute(String childName,
                                String attName)
```
  - getAttribute
```
public String getAttribute(String attName)
```
    Returns value for the supplied attribute. As attributes are stored in a list, it's a plain linear probe. We may change the data structure to a Map if this degrades the performance. The assumption is that XMPP packets do not have too many attributes.
    
    Parameters:
    
    attName - attribute name
    
    Returns:
    
    value of the attribute if present otherwise null
  - getAttributes
```
public List<Pair<String,String>> getAttributes()
```
    Returns attributes for this element. Any change in the returned attributes will reflect back in this element attribute list
    
    Returns:
    
    a list of Pairs in which first value is attribute name and second is attribute value
  - getChild
```
public Element getChild(String name)
```
  - getChildStaticStr
```
public Element getChildStaticStr(String name)
```
  - getChild
```
public Element getChild(String name,
                        String child_xmlns)
```
  - getChildren
```
public List<Element> getChildren()
```
  - getChildren
```
public List<Element> getChildren(String[] elementPath)
```
  - getXMLNS
```
public String getXMLNS()
```
  - getXMLNS
```
public String getXMLNS(String[] elementPath)
```
  - removeAttribute
```
public void removeAttribute(String key)
```
  - removeChild
```
public boolean removeChild(Element child)
```
  - setAttribute
```
public void setAttribute(String key,
                         String value)
```
  - addText
```
public void addText(String text)
```
    Adds text node in the children of this element. This operation will remove exiting CDataSection and Text nodes from the children
    
    Parameters:
    
    text - String value for this element
  - addText
```
public void addText(String text,
                    boolean removeExiting)
```
    adds Text node to this element children. If removeExisting flag is on, exisitng CDataSection and Text nodes will be removed
    
    Parameters:
    
    text - String value of this element
    
    removeExiting - a flag indicating if the exisitng value should be removed
  - removeText
```
public void removeText()
```
    Removes Text nodes and CDataSection nodes from the children of this element
  - addCDATASection
```
public void addCDATASection(String cdata)
```
    Adds CDataSection node in the children of this element
    
    Parameters:
    
    cdata - CDATA content String
  - setChildren
```
public void setChildren(List<XMLNode> children)
```
  - setDefXMLNS
```
public void setDefXMLNS(String ns)
```
  - setName
```
public void setName(String argName)
```
  - setXMLNS
```
public void setXMLNS(String ns)
```
  - getName
```
public String getName()
```
  - children
```
public int children()
```
    Description copied from interface: XMLNode
    
    Returns number of children for this node. If this is leaf node, it will return zero
    
    Specified by:
    
    children in interface XMLNode
    
    Returns:
    
    number of children
  - stringify
```
public String stringify()
```
    Description copied from interface: XMLNode
    
    Returns XML representation of this XML node
    
    Specified by:
    
    stringify in interface XMLNode
    
    Returns:
    
    String value after stringifying this XMLNode
  - stringifyChildren
```
public String stringifyChildren()
```
    Description copied from interface: XMLNode
    
    Returns XML string with all the children nodes of this node
    
    Specified by:
    
    stringifyChildren in interface XMLNode
    
    Returns:
    
    String value with all the children
  - clone
```
public Element clone()
```
    Description copied from interface: XMLNode
    
    makes a deep copy of this XML Node and returns it
    
    Specified by:
    
    clone in interface XMLNode
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    cloned XMLNode instance
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - val
```
public String val()
```
    Description copied from interface: XMLNode
    
    Returns concatenated String of Text and CDataSection nodes in the children. If there is no child of type Text or CDataSection exist, this method will return null
    
    Specified by:
    
    val in interface XMLNode
    
    Returns:
    
    value of this XMLNode
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Element

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

defxmlns

xmlns

children

attributes

Constructor Detail

Element

Element

Element

Element

Method Detail

addAttribute

addAttributes

addChild

addChildren

findChild

flatMapChildren

forEachChild

getChildAttribute

getAttribute

getAttributes

getChild

getChildStaticStr

getChild

getChildren

getChildren

getXMLNS

getXMLNS

removeAttribute

removeChild

setAttribute

addText

addText

removeText

addCDATASection

setChildren

setDefXMLNS

setName

setXMLNS

getName

children

stringify

stringifyChildren

clone

equals

val

toString