tfw.base.dom.model

Class DomElement

java.lang.Object

tfw.base.dom.model.DomElement

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

A_TextElement

public class DomElement
extends java.lang.Object
implements java.io.Serializable

An implementation of Document Object Model elements.

Author:

Typhoon.Free.Wolf

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	blForceTight
private java.util.List<DomElement>	listChildren Child elements.
private java.util.Map<java.lang.String,java.lang.String>	mapAttributes Attributes.
private static long	serialVersionUID long serialVersionUID
private java.lang.String	strTagName Tag name.

Constructor Summary

Constructors

Constructor and Description
DomElement(java.lang.String strTagName) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	addChild(DomElement domChild) Appends one specified child node to the end of child node list in this node.
void	addChild(int intIdx, DomElement domChild) Inserts one specified child node at the specified position in child node list in this node.
boolean	addChildren(java.util.Collection<DomElement> colChildren) Appends all of the child nodes in the given collection to the end of child node list in this node, in the order that they are returned by the given collection's iterator.
boolean	addChildren(DomElement[] tn1dChildren) Appends all of the child nodes in the given array to the end of child node list in this node, in the order that they are returned by the given collection's iterator.
boolean	addChildren(int intIdx, java.util.Collection<DomElement> colChildren) Inserts all of the child nodes in the given collection into child node list in this node at the specified position.
boolean	addChildren(int intIdx, DomElement[] tn1dChildren) Inserts all of the child nodes in the given array into child node list in this node at the specified position.
protected java.lang.String	escapeForDocument(java.lang.String strIn, char[] char1dScope) Escapes "&"→"&amp;", "<"→"&lt;", ">"→"&gt;" and """→"&quot;" for document. See http://book.51cto .com/art/200907/138928.htm.
java.lang.String	getAttribute(java.lang.String strKey) Returns the attribute value to which the specified key is mapped, or null if attribute map in this node contains no mapping for the key.
java.util.Map<java.lang.String,java.lang.String>	getAttributes() Copies all the attributes into a new map and return.
java.util.Map<java.lang.String,java.lang.String>	getAttributes(java.util.Collection<java.lang.String> colKeys) Returns the copied map of attributes to which the specified keys are mapped, or null if attribute map in this node contains no mapping for the keys.
java.util.Map<java.lang.String,java.lang.String>	getAttributes(java.lang.String[] str1dKeys) Returns the copied map of attributes to which the specified keys are mapped, or null if attribute map in this node contains no mapping for the keys.
DomElement	getChild(int intIdx) Returns one child node at the specified position in child node list in this node.
java.util.List<DomElement>	getChildren() Copies all the child nodes into a new list and return.
java.util.List<DomElement>	getChildren(int[] int1dIndexes) Copies the child nodes that at specified positions into a new list and return.
java.lang.String	getTagName() Getting the tag name.
boolean	isForceTight() Judges whether this element to be formatted in "force tight" mode.
java.lang.String	removeAttribute(java.lang.String strKey) Removes one attribute for a key from this node if it is present.
java.util.Map<java.lang.String,java.lang.String>	removeAttributes() Removes all attributes from this node if it is present.
java.util.Map<java.lang.String,java.lang.String>	removeAttributes(java.util.Collection<java.lang.String> colKeys) Removes attributes for keys from this node if it is present.
java.util.Map<java.lang.String,java.lang.String>	removeAttributes(java.lang.String[] str1dKeys) Removes attributes for keys from this node if it is present.
boolean	removeChild(DomElement domChild) Removes the first occurrence of one specified child node from child node list in this node, if it is present.
DomElement	removeChild(int intIdx) Removes one child node at the specified position in child node list from this node.
java.util.List<DomElement>	removeChildren() Removes all child nodes in child node list from this node.
java.util.List<DomElement>	removeChildren(java.util.Collection<DomElement> colChildren) Removes from child node list all of the nodes that are contained in the specified collection (somehow similar to List.removeAll(java.util.Collection)).
java.util.List<DomElement>	removeChildren(DomElement[] tn1dChildren) Removes from child node list all of the node s that are contained in the specified array.
java.util.List<DomElement>	removeChildren(int[] int1dIndexes) Removes child nodes at the specified positions in child node list from this node.
java.lang.String	resetAttribute(java.lang.String strKey, java.lang.String strValue) Cleans attribute map, and then associates one specified value with the specified key in attribute map.
void	resetAttributes(java.util.Map<java.lang.String,java.lang.String> mapAttributes) Cleans attribute map, and then copies all of the attributes from the specified map into attribute map in this node.
boolean	resetChild(DomElement domChild) Cleans child node list, and then appends one specified child node to the end of child node list in this node.
void	resetChild(int intIdx, DomElement domChild) Cleans child node list, and then inserts one specified child node at the specified position in child node list in this node.
boolean	resetChildren(java.util.Collection<DomElement> colChildren) Cleans child node list, and then appends all of the child nodes in the given collection to the end of child node list in this node, in the order that they are returned by the given collection's iterator.
boolean	resetChildren(DomElement[] tn1dChildren) Cleans child node list, and then appends all of the child nodes in the given array to the end of child node list in this node, in the order that they are returned by the given collection's iterator.
boolean	resetChildren(int intIdx, java.util.Collection<DomElement> colChildren) Cleans child node list, and then inserts all of the child nodes in the given collection into child node list in this node at the specified position.
boolean	resetChildren(int intIdx, DomElement[] tn1dChildren) Cleans child node list, and then inserts all of the child nodes in the given array into child node list in this node at the specified position.
java.lang.String	setAttribute(java.lang.String strKey) Associates one null value with the specified key in attribute map. For probable HTML /XML usage.
java.lang.String	setAttribute(java.lang.String strKey, java.lang.String strValue) Associates one specified value with the specified key in attribute map.
void	setAttributes(java.util.Map<java.lang.String,java.lang.String> mapAttributes) Copies all of the attributes from the specified map into attribute map in this node.
void	setForceTight(boolean blForceTight) Sets a "force tight" flag to this element.
void	sortChildren(java.util.Comparator<DomElement> cmp) Sort the list of child nodes in this node.
java.lang.String	toString()
java.lang.String	toString(boolean blFirstLinePrefixFlag) Returns a string representation of the object.
java.lang.String	toString(boolean blFirstLinePrefixFlag, java.lang.String strWhiteSpaceTextUnit) Returns a string representation of the object.
java.lang.String	toString(int intPrefixWhiteSpaceCount) Returns a string representation of the object.
java.lang.String	toString(int intPrefixWhiteSpaceCount, boolean blFirstLinePrefixFlag) Returns a string representation of the object.
java.lang.String	toString(int intPrefixWhiteSpaceCount, boolean blFirstLinePrefixFlag, java.lang.String strWhiteSpaceTextUnit) Returns a string representation of the object.
java.lang.String	toString(int intPrefixWhiteSpaceCount, boolean blFirstLinePrefixFlag, java.lang.String strWhiteSpaceTextUnit, char chCasesFlag, java.lang.String[] str1dPairTagNames, java.lang.String[] str1d_TagNames) Returns a string representation of the object.
java.lang.String	toString(int intPrefixWhiteSpaceCount, java.lang.String strWhiteSpaceTextUnit) Returns a string representation of the object.
java.lang.String	toString(java.lang.String strWhiteSpaceTextUnit) Returns a string representation of the object.
java.lang.String	toTightString() Returns a tight string representation of the object.
java.lang.String	toTightString(char chCasesFlag, java.lang.String[] str1dPairTagNames, java.lang.String[] str1d_TagNames) Returns a tight string representation of the object.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

long serialVersionUID

blForceTight

private boolean blForceTight

listChildren

private java.util.List<DomElement> listChildren

Child elements.

mapAttributes

private java.util.Map<java.lang.String,java.lang.String> mapAttributes

Attributes.

strTagName

private java.lang.String strTagName

Tag name.

Constructor Detail

DomElement

public DomElement(java.lang.String strTagName)

Constructor.

Parameters:

strTagName - - Tag name.

Method Detail

isForceTight

public boolean isForceTight()

Judges whether this element to be formatted in "force tight" mode.

Returns:

A boolean flag that indicates whether this element to be formatted in "force tight" mode:

• false: Goes normal way.
  
• true : This element is to be formated in "force tight" mode, no matter which "toString(...)" or "toTightString(...)" is called.
  

setForceTight

public void setForceTight(boolean blForceTight)

Sets a "force tight" flag to this element.

Parameters:

blForceTight - - A boolean flag that indicates whether this element to be formatted in "force tight" mode:

• false: Goes normal way.
  
• true : This element is to be formated in "force tight" mode, no matter which "toString(...)" or "toTightString(...)" is called.
  

addChild

public boolean addChild(DomElement domChild)

Appends one specified child node to the end of child node list in this node.

Parameters:

domChild - - The child node to be appended to the child node list in this node.

Returns:

true if child node list changed as a result of the call.

See Also:

List.add(Object)

addChild

public void addChild(int intIdx,
                     DomElement domChild)

Inserts one specified child node at the specified position in child node list in this node.

Parameters:

intIdx - - The index at which the specified child node is to be inserted.

domChild - - The child node to be inserted to the child node list in this node.

See Also:

List.add(int, Object)

addChildren

public boolean addChildren(DomElement[] tn1dChildren)

Appends all of the child nodes in the given array to the end of child node list in this node, in the order that they are returned by the given collection's iterator.

Parameters:

tn1dChildren - - Container containing the child nodes to append into this node.

Returns:

true if child node list changed as a result of the call.

See Also:

addChildren(int, DomElement[])

addChildren

public boolean addChildren(int intIdx,
                           DomElement[] tn1dChildren)

Inserts all of the child nodes in the given array into child node list in this node at the specified position.

Parameters:

intIdx - - The index at which to insert the first child node from the given collection.

tn1dChildren - - Container containing the child nodes to append into this node.

Returns:

true if child node list changed as a result of the call.

addChildren

public boolean addChildren(java.util.Collection<DomElement> colChildren)

Appends all of the child nodes in the given collection to the end of child node list in this node, in the order that they are returned by the given collection's iterator.

Parameters:

colChildren - - Container containing the child nodes to append into this node.

Returns:

true if child node list changed as a result of the call.

See Also:

List.addAll(Collection)

addChildren

public boolean addChildren(int intIdx,
                           java.util.Collection<DomElement> colChildren)

Inserts all of the child nodes in the given collection into child node list in this node at the specified position.

Parameters:

intIdx - - The index at which to insert the first child node from the given collection.

colChildren - - Container containing the child nodes to append into this node.

Returns:

true if child node list changed as a result of the call.

See Also:

List.addAll(int, Collection)

getChild

public DomElement getChild(int intIdx)

Returns one child node at the specified position in child node list in this node.

Parameters:

intIdx - - The index of the child node to return.

Returns:

The child node at the specified position in child node list in this node.

See Also:

List.get(int)

getChildren

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

Copies all the child nodes into a new list and return.

Returns:

A copy of child node list.

getChildren

public java.util.List<DomElement> getChildren(int[] int1dIndexes)

Copies the child nodes that at specified positions into a new list and return.

Parameters:

int1dIndexes - - The indexes of the child nodes to return.

Returns:

A list of matched child node list.

removeChild

public DomElement removeChild(int intIdx)

Removes one child node at the specified position in child node list from this node.

Parameters:

intIdx - - The index of the child node to be removed.

Returns:

The child node previously at the specified position.

See Also:

List.remove(int)

removeChild

public boolean removeChild(DomElement domChild)

Removes the first occurrence of one specified child node from child node list in this node, if it is present.

Parameters:

domChild - - The child node to be removed from child node list, if present.

Returns:

true if child node list changed as a result of the call.

See Also:

List.remove(Object)

removeChildren

public java.util.List<DomElement> removeChildren()

Removes all child nodes in child node list from this node.

Returns:

List of non-null child nodes that removed from this node.

See Also:

removeChildren(Collection)

removeChildren

public java.util.List<DomElement> removeChildren(int[] int1dIndexes)

Removes child nodes at the specified positions in child node list from this node.

Parameters:

int1dIndexes - - The indexes of the child nodes to be removed.

Returns:

List of non-null child nodes that removed from this node.

removeChildren

public java.util.List<DomElement> removeChildren(DomElement[] tn1dChildren)

Removes from child node list all of the node s that are contained in the specified array.

Parameters:

tn1dChildren - - Container containing nodes to be removed from child node list.

Returns:

List of non-null child nodes that removed from this node.

removeChildren

public java.util.List<DomElement> removeChildren(java.util.Collection<DomElement> colChildren)

Removes from child node list all of the nodes that are contained in the specified collection (somehow similar to List.removeAll(java.util.Collection)).

Parameters:

colChildren - - The collection containing nodes to be removed from child node list.

Returns:

List of non-null child nodes that removed from this node.

See Also:

removeChildren(DomElement[])

resetChild

public boolean resetChild(DomElement domChild)

Cleans child node list, and then appends one specified child node to the end of child node list in this node.

Parameters:

domChild - - The child node to be appended to the child node list in this node.

Returns:

true if child node list changed as a result of the call.

See Also:

removeChildren(), addChild(DomElement)

resetChild

public void resetChild(int intIdx,
                       DomElement domChild)

Cleans child node list, and then inserts one specified child node at the specified position in child node list in this node.

Parameters:

intIdx - - The index at which the specified child node is to be inserted.

domChild - - The child node to be inserted to the child node list in this node.

See Also:

removeChildren(), addChild(int, DomElement)

resetChildren

public boolean resetChildren(DomElement[] tn1dChildren)

Cleans child node list, and then appends all of the child nodes in the given array to the end of child node list in this node, in the order that they are returned by the given collection's iterator.

Parameters:

tn1dChildren - - Container containing the child nodes to append into this node.

Returns:

true if child node list changed as a result of the call.

See Also:

removeChildren(), addChildren(DomElement[])

resetChildren

public boolean resetChildren(int intIdx,
                             DomElement[] tn1dChildren)

Cleans child node list, and then inserts all of the child nodes in the given array into child node list in this node at the specified position.

Parameters:

intIdx - - The index at which to insert the first child node from the given collection.

tn1dChildren - - Container containing nodes to be removed from child node list.

Returns:

true if child node list changed as a result of the call.

See Also:

removeChildren(), addChildren(int, DomElement[])

resetChildren

public boolean resetChildren(java.util.Collection<DomElement> colChildren)

Cleans child node list, and then appends all of the child nodes in the given collection to the end of child node list in this node, in the order that they are returned by the given collection's iterator.

Parameters:

colChildren - - Container containing nodes to be removed from child node list.

Returns:

true if child node list changed as a result of the call.

See Also:

removeChildren(), addChildren(Collection)

resetChildren

public boolean resetChildren(int intIdx,
                             java.util.Collection<DomElement> colChildren)

Cleans child node list, and then inserts all of the child nodes in the given collection into child node list in this node at the specified position.

Parameters:

intIdx - - The index at which to insert the first child node from the given collection.

colChildren - - Container containing nodes to be removed from child node list.

Returns:

true if child node list changed as a result of the call.

See Also:

removeChildren(), addChildren(int, Collection)

sortChildren

public void sortChildren(java.util.Comparator<DomElement> cmp)

Sort the list of child nodes in this node.

Parameters:

cmp - - Comparator to sort child nodes.
Do nothing while null passed in!

setAttribute

public java.lang.String setAttribute(java.lang.String strKey)

Associates one null value with the specified key in attribute map.
For probable HTML /XML usage.

Parameters:

strKey - - The key with which the specified value is to be associated.

Returns:

The previous value associated with key, or null if there was no mapping for key.

See Also:

Map.put(Object, Object)

setAttribute

public java.lang.String setAttribute(java.lang.String strKey,
                                     java.lang.String strValue)

Associates one specified value with the specified key in attribute map.

Parameters:

strKey - - The key with which the specified value is to be associated.

strValue - - The value to be associated with the specified key.

Returns:

The previous value associated with key, or null if there was no mapping for key.

See Also:

Map.put(Object, Object)

setAttributes

public void setAttributes(java.util.Map<java.lang.String,java.lang.String> mapAttributes)

Copies all of the attributes from the specified map into attribute map in this node.

Parameters:

mapAttributes - - The foreign attributes to be copied into this node.

See Also:

Map.putAll(Map)

getAttribute

public java.lang.String getAttribute(java.lang.String strKey)

Returns the attribute value to which the specified key is mapped, or null if attribute map in this node contains no mapping for the key.

Parameters:

strKey - - The key whose associated value is to be returned.

Returns:

The attribute value to which the specified key is mapped, or null if this map contains no mapping for the key.

See Also:

Map.get(Object)

getAttributes

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

Copies all the attributes into a new map and return.

Returns:

A copy of attribute map.

getAttributes

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

Returns the copied map of attributes to which the specified keys are mapped, or null if attribute map in this node contains no mapping for the keys.

Parameters:

str1dKeys - - Container containing the keys whose associated values are to be returned.

Returns:

A copy of queried attribute map.

getAttributes

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

Returns the copied map of attributes to which the specified keys are mapped, or null if attribute map in this node contains no mapping for the keys.

Parameters:

colKeys - - Container containing the keys whose associated values are to be returned.

Returns:

A copy of queried attribute map.

See Also:

getAttributes(String[])

removeAttribute

public java.lang.String removeAttribute(java.lang.String strKey)

Removes one attribute for a key from this node if it is present.

Parameters:

strKey - - The key whose attribute is to be removed from this node.

Returns:

The previous attribute value associated with key, or null if there was no mapping for key.

See Also:

Map.remove(Object)

removeAttributes

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

Removes all attributes from this node if it is present.

Returns:

The previous attribute values associated with keys, or null if there were no mappings for keys.

See Also:

removeAttributes(String[])

removeAttributes

public java.util.Map<java.lang.String,java.lang.String> removeAttributes(java.lang.String[] str1dKeys)

Removes attributes for keys from this node if it is present.

Parameters:

str1dKeys - - Container containing the keys whose attributes are to be removed from this node.

Returns:

The previous attribute values associated with keys, or null if there were no mappings for keys.

removeAttributes

public java.util.Map<java.lang.String,java.lang.String> removeAttributes(java.util.Collection<java.lang.String> colKeys)

Removes attributes for keys from this node if it is present.

Parameters:

colKeys - - Container containing the keys whose attributes are to be removed from this node.

Returns:

The previous attribute values associated with keys, or null if there were no mappings for keys.

See Also:

removeAttributes(String[])

resetAttribute

public java.lang.String resetAttribute(java.lang.String strKey,
                                       java.lang.String strValue)

Cleans attribute map, and then associates one specified value with the specified key in attribute map.

Parameters:

strKey - - The key with which the specified value is to be associated.

strValue - - The value to be associated with the specified key.

Returns:

The previous value associated with key, or null if there was no mapping for key.

See Also:

removeAttributes(), Map.put(Object, Object)

resetAttributes

public void resetAttributes(java.util.Map<java.lang.String,java.lang.String> mapAttributes)

Cleans attribute map, and then copies all of the attributes from the specified map into attribute map in this node.

Parameters:

mapAttributes - - The foreign attributes to be copied into this node.

See Also:

removeAttributes(), Map.putAll(Map)

getTagName

public java.lang.String getTagName()

Getting the tag name.

Returns:

Tag name.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the object.

See Also:

Object.toString()

toString

public java.lang.String toString(int intPrefixWhiteSpaceCount)

Returns a string representation of the object.

Parameters:

intPrefixWhiteSpaceCount - - Count of prefix white space.

Returns:

A string representation of the object.

toString

public java.lang.String toString(boolean blFirstLinePrefixFlag)

Returns a string representation of the object.

Parameters:

blFirstLinePrefixFlag - - A boolean flag that indicates use or NOT use a prefix to the first line of the text:

• true : Use prefix blanks to the first line;
  
• false: Not use prefix blanks to the first line;
  

Returns:

A string representation of the object.

toString

public java.lang.String toString(java.lang.String strWhiteSpaceTextUnit)

Returns a string representation of the object.

Parameters:

strWhiteSpaceTextUnit - - Text unit of white space.

Returns:

A string representation of the object.

toString

public java.lang.String toString(int intPrefixWhiteSpaceCount,
                                 boolean blFirstLinePrefixFlag)

Returns a string representation of the object.

Parameters:

intPrefixWhiteSpaceCount - - Count of prefix white space.

blFirstLinePrefixFlag - - A boolean flag that indicates use or NOT use a prefix to the first line of the text:

• true : Use prefix blanks to the first line;
  
• false: Not use prefix blanks to the first line;
  

Returns:

A string representation of the object.

toString

public java.lang.String toString(int intPrefixWhiteSpaceCount,
                                 java.lang.String strWhiteSpaceTextUnit)

Returns a string representation of the object.

Parameters:

intPrefixWhiteSpaceCount - - Count of prefix white space.

strWhiteSpaceTextUnit - - Text unit of white space.

Returns:

A string representation of the object.

toString

public java.lang.String toString(boolean blFirstLinePrefixFlag,
                                 java.lang.String strWhiteSpaceTextUnit)

Returns a string representation of the object.

Parameters:

blFirstLinePrefixFlag - - A boolean flag that indicates use or NOT use a prefix to the first line of the text:

• true : Use prefix blanks to the first line;
  
• false: Not use prefix blanks to the first line;
  

strWhiteSpaceTextUnit - - Text unit of white space.

Returns:

A string representation of the object.

toString

public java.lang.String toString(int intPrefixWhiteSpaceCount,
                                 boolean blFirstLinePrefixFlag,
                                 java.lang.String strWhiteSpaceTextUnit)

Returns a string representation of the object.

Parameters:

intPrefixWhiteSpaceCount - - Count of prefix white space.

blFirstLinePrefixFlag - - A boolean flag that indicates use or NOT use a prefix to the first line of the text:

• true : Use prefix blanks to the first line;
  
• false: Not use prefix blanks to the first line;
  

strWhiteSpaceTextUnit - - Text unit of white space.

Returns:

A string representation of the object.

toString

public java.lang.String toString(int intPrefixWhiteSpaceCount,
                                 boolean blFirstLinePrefixFlag,
                                 java.lang.String strWhiteSpaceTextUnit,
                                 char chCasesFlag,
                                 java.lang.String[] str1dPairTagNames,
                                 java.lang.String[] str1d_TagNames)

Returns a string representation of the object.

Parameters:

intPrefixWhiteSpaceCount - - Count of prefix white space.

blFirstLinePrefixFlag - - A boolean flag that indicates use or NOT use a prefix to the first line of the text:

• true : Use prefix blanks to the first line;
  
• false: Not use prefix blanks to the first line;
  

strWhiteSpaceTextUnit - - Text unit of white space; null would be processed as "\t".

chCasesFlag - - Character cases of the tag names and attribute names:

• 'N', 'n' or undefined: Not to change the cases of the tag names and attribute names;
  
• 'L' or 'l': Change cases of the tag names and attribute names lower;
  
• 'U' or 'u': Change cases of the tag names and attribute names upper.
  

str1dPairTagNames - - The names of the tags that must appear in pairs, even if they contain no child elements; null or empty are acceptable.

str1d_TagNames - - The names of the tags that must have a blank character before their "/>", if they contain no child elements; null or empty are acceptable.

Returns:

A string representation of the object.

toTightString

public java.lang.String toTightString()

Returns a tight string representation of the object.

Returns:

A tight string representation of the object.

toTightString

public java.lang.String toTightString(char chCasesFlag,
                                      java.lang.String[] str1dPairTagNames,
                                      java.lang.String[] str1d_TagNames)

Returns a tight string representation of the object.

Parameters:

chCasesFlag - - Character cases of the tag names and attribute names:

• 'N', 'n' or undefined: Not to change the cases of the tag names and attribute names;
  
• 'L' or 'l': Change cases of the tag names and attribute names lower;
  
• 'U' or 'u': Change cases of the tag names and attribute names upper.
  

str1dPairTagNames - - The names of the tags that must appear in pairs, even if they contain no child elements; null or empty are acceptable.

str1d_TagNames - - The names of the tags that must have a blank character before their "/>", if they contain no child elements; null or empty are acceptable.

Returns:

A tight string representation of the object.

escapeForDocument

protected final java.lang.String escapeForDocument(java.lang.String strIn,
                                                   char[] char1dScope)

Escapes "&"→"&amp;", "<"→"&lt;", ">"→"&gt;" and """→"&quot;" for document.
See http://book.51cto .com/art/200907/138928.htm.

Parameters:

strIn - - The incoming text to be escapes.

char1dScope - - The scope of characters to be escapes.

Returns:

Escaped text.