com.ps.xml

Class Tag

java.lang.Object

com.ps.xml.Tag

Direct Known Subclasses:

TagReader

public class Tag
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Tag(java.lang.String name)
Tag(java.lang.String name, boolean maintainAttributeOrder) Constructor which allows to chose whether the order of tag attributes shall remain unchanged.
Tag(java.lang.String name, java.lang.String content)
Tag(java.lang.String name, java.lang.String content, boolean maintainAttributeOrder) Constructor which allows to chose whether the order of tag attributes shall remain unchanged.

Method Summary

Modifier and Type	Method and Description
void	accept(TagVisitor visitor) Visit the tag and its sub tags.
void	addAttribute(java.lang.String name, java.lang.String value)
Tag	addChild(java.lang.String tagname)
Tag	addChild(java.lang.String tagname, int position)
Tag	addChild(Tag child)
Tag	addChild(Tag child, int position)
void	addContent(java.lang.String content) Add the given string to the content.
Tag	ensureChild(java.lang.String name)
Tag	find(java.lang.String tagname, java.lang.String attrname, java.lang.String attrvalue)
java.lang.String	getAllContent() Get the content of the tag and all sub tags.
java.util.Map<java.lang.String,java.lang.String>	getAttributes()
java.lang.String	getAttributeValue(java.lang.String name)
java.lang.String	getAttributeValue(java.lang.String name, java.lang.String value) Get the value of the given attribute.
Tag	getChild(java.lang.String name)
Tag	getChild(java.lang.String[] path)
protected Tag	getChild(java.lang.String[] path, int idx)
java.util.List<Tag>	getChildren()
java.util.List<Tag>	getChildren(java.lang.String name)
java.lang.String	getContent()
int	getEndLine()
java.lang.String	getName()
Tag	getParent()
int	getStartLine()
Tag	getToplevelTag(java.lang.String name)
boolean	hasAttribute(java.lang.String name)
boolean	hasAttributes()
boolean	hasChildren()
boolean	hasChildren(java.lang.String name)
boolean	hasContent()
void	remChild(Tag child)
void	remove()
void	removeAttribute(java.lang.String name)
void	setContent(java.lang.String content)
void	setEndLine(int line)
void	setName(java.lang.String name)
void	setParent(Tag parent)
void	setStartLine(int line)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Tag

public Tag(java.lang.String name)

Tag

public Tag(java.lang.String name,
           java.lang.String content)

Tag

public Tag(java.lang.String name,
           boolean maintainAttributeOrder)

Constructor which allows to chose whether the order of tag attributes shall remain unchanged. Default is false. If false is selected the attribute are stored into an HashMap, which does not have a defined order.

Parameters:

name - The name of the tag.

maintainAttributeOrder -

Since:

6.0.2

Tag

public Tag(java.lang.String name,
           java.lang.String content,
           boolean maintainAttributeOrder)

Constructor which allows to chose whether the order of tag attributes shall remain unchanged. Default is false. If false is selected the attribute are stored into an HashMap, which does not have a defined order.

Parameters:

name - The name of the tag.

content - text content of the tag

maintainAttributeOrder -

Since:

6.0.2

Method Detail

setName

public void setName(java.lang.String name)

getName

public java.lang.String getName()

hasContent

public boolean hasContent()

setContent

public void setContent(java.lang.String content)

addContent

public void addContent(java.lang.String content)

Add the given string to the content.

Parameters:

content -

Since:

3.2.6

getContent

public java.lang.String getContent()

getAllContent

public java.lang.String getAllContent()

Get the content of the tag and all sub tags. All XML tag are removed.

Returns:

The content as string.

Since:

3.2.6

setStartLine

public void setStartLine(int line)

getStartLine

public int getStartLine()

setEndLine

public void setEndLine(int line)

getEndLine

public int getEndLine()

setParent

public void setParent(Tag parent)

getParent

public Tag getParent()

hasAttributes

public boolean hasAttributes()

hasAttribute

public boolean hasAttribute(java.lang.String name)

addAttribute

public void addAttribute(java.lang.String name,
                         java.lang.String value)

getAttributeValue

public java.lang.String getAttributeValue(java.lang.String name)

removeAttribute

public void removeAttribute(java.lang.String name)

getAttributeValue

public java.lang.String getAttributeValue(java.lang.String name,
                                          java.lang.String value)

Get the value of the given attribute. If the attribute doesn't exists the given default value is returned.

Parameters:

name - the name of the attribute

value - the default value

Returns:

the value of the attribute or the default value if the attribute doesn't exists

Since:

3.2.6

getAttributes

public java.util.Map<java.lang.String,java.lang.String> getAttributes()

remove

public void remove()

hasChildren

public boolean hasChildren()

addChild

public Tag addChild(Tag child,
                    int position)

addChild

public Tag addChild(java.lang.String tagname,
                    int position)

addChild

public Tag addChild(java.lang.String tagname)

addChild

public Tag addChild(Tag child)

remChild

public void remChild(Tag child)

getChildren

public java.util.List<Tag> getChildren()

ensureChild

public Tag ensureChild(java.lang.String name)

getChild

public Tag getChild(java.lang.String name)

getChild

public Tag getChild(java.lang.String[] path)

getChild

protected Tag getChild(java.lang.String[] path,
                       int idx)

hasChildren

public boolean hasChildren(java.lang.String name)

getChildren

public java.util.List<Tag> getChildren(java.lang.String name)

getToplevelTag

public Tag getToplevelTag(java.lang.String name)

find

public Tag find(java.lang.String tagname,
                java.lang.String attrname,
                java.lang.String attrvalue)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

accept

public void accept(TagVisitor visitor)

Visit the tag and its sub tags.

Parameters:

visitor - the TagVisitor

Since:

3.2.6