Class Element

java.lang.Object

tigase.xml.Element

All Implemented Interfaces:

Cloneable, Comparable<Element>, XMLNodeIfc<Element>

Direct Known Subclasses:

DBElement

@TODO(note="Make it a bit lighter.")
public class Element
extends Object
implements XMLNodeIfc<Element>

Element - basic document tree node implementation. Supports Java 5.0 generic feature to make it easier to extend this class and still preserve some useful functionality. Sufficient for simple cases but probably in the most more advanced cases should be extended with additional features. Look in API documentation for more details and information about existing extensions. The most important features apart from abvious tree implementation are:

• toString() implementation so it can generate valid XML content from this element and all children.
• addChild(...), getChild(childName) supporting generic types.
• findChild(childPath) finding child in subtree by given path to element.
• getChildCData(childPath), getAttribute(childPath, attName) returning element CData from child in subtree by given path to element.

Created: Mon Oct 4 17:55:16 2004

Version:

$Rev$

Author:

Artur Hefczyc

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Element.Matcher<T>	Deprecated. replaced with usage of Predicate
protected class	Element.XMLIdentityHashMap<K,V>	Deprecated.

Field Summary

Fields

Modifier and Type	Field	Description
protected Element.XMLIdentityHashMap<String,String>	attributes	Deprecated.
protected LinkedList<XMLNodeIfc>	children	Deprecated.
protected String	defxmlns	Deprecated.
protected String	name	Deprecated.
protected String	xmlns	Deprecated.

Constructor Summary

Constructors

Constructor	Description
Element(String argName)	Deprecated.
Element(String argName, String argCData)	Deprecated. use Element(java.lang.String) instead.
Element(String argName, String[] att_names, String[] att_values)	Deprecated. use Element(java.lang.String) instead.
Element(String argName, String argCData, String[] att_names, String[] att_values)	Deprecated. use Element(java.lang.String) instead.
Element(String argName, String argCData, StringBuilder[] att_names, StringBuilder[] att_values)	Deprecated. use Element(java.lang.String) instead.
Element(String argName, Element[] children, String[] att_names, String[] att_values)	Deprecated. use Element(java.lang.String) instead.
Element(Element element)

Method Summary

Modifier and Type	Method	Description
void	addAttribute(String attName, String attValue)	Deprecated. use setAttribute(String, String) } instead.
void	addAttributes(Map<String,String> attrs)	Deprecated.
void	addCData(String argCData)
void	addChild(XMLNodeIfc child)	Deprecated.
void	addChildren(List<Element> children)
protected String	cdataToString()
String	childrenToString()	Deprecated.
void	childrenToString(StringBuilder result)	Deprecated.
String	childrenToStringPretty()	Deprecated.
String	childrenToStringSecure()	Deprecated.
void	childrenToStringSecure(StringBuilder result)	Deprecated.
Element	clone()
int	compareTo(Element elem)	Deprecated.
boolean	equals(Object obj)
Element	findChild(String elementPath)	Deprecated. use findChild(java.lang.String[]) instead.
Element	findChild(String[] elemPath)	Deprecated.
Element	findChild(Element.Matcher<Element> matcher)	Deprecated.
List<Element>	findChildren(Element.Matcher<Element> matcher)	Deprecated.
Element	findChildStaticStr(String[] elementPath)	Deprecated.
<R> List<R>	flatMapChildren(Function<Element, Collection<? extends R>> mapper)	Deprecated.
void	forEachChild(Consumer<Element> consumer)
String	getAttribute(String attName)
String	getAttribute(String[] elementPath, String att_name)	Deprecated.
String	getAttribute(String elementPath, String att_name)	Deprecated.
Map<String,String>	getAttributes()
String	getAttributeStaticStr(String attName)	Deprecated.
String	getAttributeStaticStr(String[] elementPath, String att_name)	Deprecated.
String	getCData()
String	getCData(String elementPath)	Deprecated. use getCData(java.lang.String[]) instead.
String	getCData(String[] elementPath)	Deprecated.
String	getCDataStaticStr(String[] elementPath)	Deprecated.
Element	getChild(String name)	Deprecated.
Element	getChild(String name, String child_xmlns)	Deprecated.
String	getChildAttribute(String childName, String attName)	Deprecated. use getChildAttributeStaticStr(java.lang.String, java.lang.String) instead.
String	getChildAttributeStaticStr(String childName, String attName)	Deprecated.
String	getChildCData(String elementPath)	Deprecated. use getCData(java.lang.String[]) instead.
String	getChildCData(String[] elementPath)	Deprecated.
String	getChildCData(Element.Matcher<Element> matcher)	Deprecated.
String	getChildCDataStaticStr(String[] elementPath)	Deprecated.
List<Element>	getChildren()
List<Element>	getChildren(String elementPath)	Deprecated. use getChildren(java.lang.String[]) instead.
List<Element>	getChildren(String[] elementPath)	Deprecated.
List<Element>	getChildren(Element.Matcher<Element> matcher)	Deprecated.
List<Element>	getChildrenStaticStr(String[] elementPath)	Deprecated.
Element	getChildStaticStr(String name)	Deprecated.
Element	getChildStaticStr(String name, String child_xmlns)	Deprecated.
String	getName()
String	getXMLNS()
String	getXMLNS(String elementPath)	Deprecated. use getXMLNS(java.lang.String[]) instead.
String	getXMLNS(String[] elementPath)	Deprecated.
String	getXMLNSStaticStr(String[] elementPath)	Deprecated.
int	hashCode()
static void	main(String[] args)
<R> R	map(Function<Element, ? extends R> mapper)
<R> List<R>	mapChildren(Function<Element, ? extends R> mapper)
<R> List<R>	mapChildren(Element.Matcher<Element> matcher, Function<Element, ? extends R> mapper)	Deprecated.
boolean	matches(Element.Matcher<Element> matcher)	Deprecated.
void	removeAttribute(String key)
boolean	removeChild(Element child)
void	setAttribute(String key, String value)
void	setAttributes(String[] names, String[] values)	Deprecated.
void	setAttributes(StringBuilder[] names, StringBuilder[] values)	Deprecated.
void	setAttributes(Map<String,String> newAttributes)
void	setAttributeStaticStr(String[] elementPath, String att_name, String att_value)	Deprecated.
void	setCData(String argCData)
void	setChildren(List<XMLNodeIfc> children)
void	setDefXMLNS(String ns)	Deprecated.
void	setName(String argName)
void	setXMLNS(String ns)
String	toString()
void	toString(StringBuilder result)
String	toStringNoChildren()
String	toStringPretty()
String	toStringSecure()
void	toStringSecure(StringBuilder result)
Element	withAttribute(String attName, String attValue)	Deprecated.
Element	withElement(String name, String xmlns, String cdata)	Deprecated.
Element	withElement(String name, String xmlns, Consumer<Element> consumer)	Deprecated.
Element	withElement(String name, Consumer<Element> consumer)	Deprecated.

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

attributes

@Deprecated
protected Element.XMLIdentityHashMap<String,String> attributes

Deprecated.

children

@Deprecated
protected LinkedList<XMLNodeIfc> children

Deprecated.

defxmlns

@Deprecated
protected String defxmlns

Deprecated.

name

@Deprecated
protected String name

Deprecated.

xmlns

@Deprecated
protected String xmlns

Deprecated.

Constructor Details

Element

public Element(Element element)

Element

@Deprecated
public Element(String argName)

Deprecated.

Element

@Deprecated
public Element(String argName,
 String argCData)

Deprecated.

use Element(java.lang.String) instead.

Element

@Deprecated
public Element(String argName,
 String[] att_names,
 String[] att_values)

Deprecated.

use Element(java.lang.String) instead.

Element

@Deprecated
public Element(String argName,
 Element[] children,
 String[] att_names,
 String[] att_values)

Deprecated.

use Element(java.lang.String) instead.

Element

@Deprecated
public Element(String argName,
 String argCData,
 String[] att_names,
 String[] att_values)

Deprecated.

use Element(java.lang.String) instead.

Element

@Deprecated
public Element(String argName,
 String argCData,
 StringBuilder[] att_names,
 StringBuilder[] att_values)

Deprecated.

use Element(java.lang.String) instead.

Method Details

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception

addAttribute

@Deprecated
public void addAttribute(String attName,
 String attValue)

Deprecated.

use setAttribute(String, String) } instead.

addAttributes

@Deprecated
public void addAttributes(Map<String,String> attrs)

Deprecated.

addCData

public void addCData(String argCData)

addChild

@Deprecated
public void addChild(XMLNodeIfc child)

Deprecated.

addChildren

public void addChildren(List<Element> children)

childrenToString

@Deprecated
public String childrenToString()

Deprecated.

childrenToString

@Deprecated
public void childrenToString(StringBuilder result)

Deprecated.

childrenToStringPretty

@Deprecated
public String childrenToStringPretty()

Deprecated.

childrenToStringSecure

@Deprecated
public String childrenToStringSecure()

Deprecated.

childrenToStringSecure

@Deprecated
public void childrenToStringSecure(StringBuilder result)

Deprecated.

clone

public Element clone()

Specified by:

clone in interface XMLNodeIfc<Element>

Overrides:

clone in class Object

compareTo

@Deprecated
public int compareTo(Element elem)

Deprecated.

Specified by:

compareTo in interface Comparable<Element>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

findChildStaticStr

@Deprecated
public Element findChildStaticStr(String[] elementPath)

Deprecated.

findChild

@Deprecated
public Element findChild(String[] elemPath)

Deprecated.

findChild

@Deprecated
public Element findChild(String elementPath)

Deprecated.

use findChild(java.lang.String[]) instead.

findChild

@Deprecated
public Element findChild(Element.Matcher<Element> matcher)

Deprecated.

findChildren

@Deprecated
public List<Element> findChildren(Element.Matcher<Element> matcher)

Deprecated.

flatMapChildren

@Deprecated
public <R> List<R> flatMapChildren(Function<Element, Collection<? extends R>> mapper)

Deprecated.

forEachChild

public void forEachChild(Consumer<Element> consumer)

getAttribute

public String getAttribute(String attName)

getChildAttribute

@Deprecated
public String getChildAttribute(String childName,
 String attName)

Deprecated.

use getChildAttributeStaticStr(java.lang.String, java.lang.String) instead.

getChildAttributeStaticStr

@Deprecated
public String getChildAttributeStaticStr(String childName,
 String attName)

Deprecated.

getAttributeStaticStr

@Deprecated
public String getAttributeStaticStr(String attName)

Deprecated.

getAttribute

@Deprecated
public String getAttribute(String elementPath,
 String att_name)

Deprecated.

getAttribute

@Deprecated
public String getAttribute(String[] elementPath,
 String att_name)

Deprecated.

getAttributeStaticStr

@Deprecated
public String getAttributeStaticStr(String[] elementPath,
 String att_name)

Deprecated.

getAttributes

public Map<String,String> getAttributes()

setAttributes

public void setAttributes(Map<String,String> newAttributes)

getCData

@Deprecated
public String getCData(String elementPath)

Deprecated.

use getCData(java.lang.String[]) instead.

getCData

@Deprecated
public String getCData(String[] elementPath)

Deprecated.

getCDataStaticStr

@Deprecated
public String getCDataStaticStr(String[] elementPath)

Deprecated.

getCData

public String getCData()

setCData

public void setCData(String argCData)

getChild

@Deprecated
public Element getChild(String name)

Deprecated.

getChildStaticStr

@Deprecated
public Element getChildStaticStr(String name)

Deprecated.

getChild

@Deprecated
public Element getChild(String name,
 String child_xmlns)

Deprecated.

getChildStaticStr

@Deprecated
public Element getChildStaticStr(String name,
 String child_xmlns)

Deprecated.

getChildCData

@Deprecated
public String getChildCData(String elementPath)

Deprecated.

use getCData(java.lang.String[]) instead.

getChildCData

@Deprecated
public String getChildCData(String[] elementPath)

Deprecated.

getChildCDataStaticStr

@Deprecated
public String getChildCDataStaticStr(String[] elementPath)

Deprecated.

getChildCData

@Deprecated
public String getChildCData(Element.Matcher<Element> matcher)

Deprecated.

getChildren

public List<Element> getChildren()

setChildren

public void setChildren(List<XMLNodeIfc> children)

getChildren

@Deprecated
public List<Element> getChildren(String elementPath)

Deprecated.

use getChildren(java.lang.String[]) instead.

getChildren

@Deprecated
public List<Element> getChildren(String[] elementPath)

Deprecated.

getChildrenStaticStr

@Deprecated
public List<Element> getChildrenStaticStr(String[] elementPath)

Deprecated.

getChildren

@Deprecated
public List<Element> getChildren(Element.Matcher<Element> matcher)

Deprecated.

getName

public String getName()

setName

public void setName(String argName)

getXMLNS

public String getXMLNS()

setXMLNS

public void setXMLNS(String ns)

getXMLNS

@Deprecated
public String getXMLNS(String elementPath)

Deprecated.

use getXMLNS(java.lang.String[]) instead.

getXMLNS

@Deprecated
public String getXMLNS(String[] elementPath)

Deprecated.

getXMLNSStaticStr

@Deprecated
public String getXMLNSStaticStr(String[] elementPath)

Deprecated.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

map

public <R> R map(Function<Element, ? extends R> mapper)

mapChildren

public <R> List<R> mapChildren(Function<Element, ? extends R> mapper)

mapChildren

@Deprecated
public <R> List<R> mapChildren(Element.Matcher<Element> matcher,
 Function<Element, ? extends R> mapper)

Deprecated.

matches

@Deprecated
public boolean matches(Element.Matcher<Element> matcher)

Deprecated.

removeAttribute

public void removeAttribute(String key)

removeChild

public boolean removeChild(Element child)

setAttributeStaticStr

@Deprecated
public void setAttributeStaticStr(String[] elementPath,
 String att_name,
 String att_value)

Deprecated.

setAttribute

public void setAttribute(String key,
 String value)

setAttributes

@Deprecated
public void setAttributes(StringBuilder[] names,
 StringBuilder[] values)

Deprecated.

setAttributes

@Deprecated
public void setAttributes(String[] names,
 String[] values)

Deprecated.

setDefXMLNS

@Deprecated
public void setDefXMLNS(String ns)

Deprecated.

toString

public String toString()

Overrides:

toString in class Object

toString

public void toString(StringBuilder result)

toStringPretty

public String toStringPretty()

Specified by:

toStringPretty in interface XMLNodeIfc<Element>

toStringNoChildren

public String toStringNoChildren()

toStringSecure

public String toStringSecure()

Specified by:

toStringSecure in interface XMLNodeIfc<Element>

toStringSecure

public void toStringSecure(StringBuilder result)

withAttribute

@Deprecated
public Element withAttribute(String attName,
 String attValue)

Deprecated.

withElement

@Deprecated
public Element withElement(String name,
 Consumer<Element> consumer)

Deprecated.

withElement

@Deprecated
public Element withElement(String name,
 String xmlns,
 String cdata)

Deprecated.

withElement

@Deprecated
public Element withElement(String name,
 String xmlns,
 Consumer<Element> consumer)

Deprecated.

cdataToString

protected String cdataToString()