com.helger.xml.microdom

Class MicroText

java.lang.Object

com.helger.xml.microdom.AbstractMicroNode

com.helger.xml.microdom.MicroText

All Implemented Interfaces:

com.helger.commons.hierarchy.IHasChildren<IMicroNode>, com.helger.commons.hierarchy.IHasChildrenRecursive<IMicroNode>, com.helger.commons.hierarchy.IHasChildrenSorted<IMicroNode>, com.helger.commons.hierarchy.IHasParent<IMicroNode>, com.helger.commons.lang.ICloneable<IMicroNode>, IMicroDataAware, IMicroNode, IMicroText, Serializable

public final class MicroText
extends AbstractMicroNode
implements IMicroText

Default implementation of the IMicroText interface.

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_ESCAPE By default the text should be XML escaped when emitting to a file etc.
static boolean	DEFAULT_IGNORABLE_WHITESPACE By default the text is not ignorable whitespaces

Constructor Summary

Constructors

Constructor and Description
MicroText(char[] aChars, int nOfs, int nLen, boolean bIgnorableWhitespace)
MicroText(CharSequence sText)
MicroText(CharSequence sText, boolean bIgnorableWhitespace)

Method Summary

Modifier and Type	Method and Description
void	appendData(char cChar) Append a character to the string.
void	appendData(char[] aChars, int nOfs, int nLen) Append characters to the string.
void	appendData(CharSequence sData) Append characters to the string.
IMicroText	getClone()
CharSequence	getData()
String	getNodeName()
String	getNodeValue()
EMicroNodeType	getType()
boolean	isElementContentWhitespace() Check whether the text node consists solely of whitespaces.
boolean	isEqualContent(IMicroNode o) As instances of this class may not implement equals/hashCode we need a way to determine, if 2 nodes are equal by content.
boolean	isEscape()
void	prependData(char cChar) Add a character to the beginning of the current data.
void	prependData(char[] aChars, int nOfs, int nLen) Add characters to the beginning of the current data.
void	prependData(CharSequence sData) Add characters to the beginning of the current data.
void	setData(CharSequence sData) Change the character sequence.
MicroText	setEscape(boolean bEscape)
String	toString()

Methods inherited from class com.helger.xml.microdom.AbstractMicroNode

appendChild, detachFromParent, findFirstChild, findFirstChildMapped, findParentElement, forAllChildren, forAllChildren, forAllChildrenBreakable, forAllChildrenMapped, getAllChildren, getAllEventTargets, getAllEventTargets, getChildAtIndex, getChildCount, getChildren, getFirstChild, getLastChild, getNextSibling, getParent, getPreviousSibling, hasChildren, hasParent, insertAfter, insertAtIndex, insertBefore, internalResetParentNode, internalSetParentNode, internalTriggerEvent, isCDATA, isComment, isContainer, isDocument, isDocumentType, isElement, isEntityReference, isProcessingInstruction, isText, onAppendChild, onEvent, onInsertAfter, onInsertAtIndex, onInsertBefore, onRemoveAllChildren, onRemoveChild, onRemoveChildAtIndex, registerEventTarget, removeAllChildren, removeChild, removeChildAtIndex, unregisterEventTarget

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.xml.microdom.IMicroNode

appendCDATA, appendCDATA, appendCDATA, appendCDATAWithConversion, appendChild, appendComment, appendComment, appendComment, appendCommentWithConversion, appendContainer, appendElement, appendElement, appendEntityReference, appendIgnorableWhitespaceText, appendIgnorableWhitespaceText, appendIgnorableWhitespaceText, appendProcessingInstruction, appendText, appendText, appendText, appendTextWithConversion, containsAnyChild, detachFromParent, findParentElement, getAllChildren, getAllChildrenRecursive, getAllEventTargets, getAllEventTargets, getFirstChild, getLastChild, getNextSibling, getParent, getParentElementWithName, getParentElementWithName, getPreviousSibling, hasParent, insertAfter, insertAtIndex, insertBefore, isCDATA, isComment, isContainer, isDocument, isDocumentType, isElement, isEntityReference, isProcessingInstruction, isText, registerEventTarget, removeAllChildren, removeChild, removeChildAtIndex, replaceChild, unregisterEventTarget

Methods inherited from interface com.helger.commons.hierarchy.IHasChildrenSorted

findFirstChild, findFirstChildMapped, getChildAtIndex

Methods inherited from interface com.helger.commons.hierarchy.IHasChildrenRecursive

forAllChildrenRecursive, forAllChildrenRecursive

Methods inherited from interface com.helger.commons.hierarchy.IHasChildren

forAllChildren, forAllChildren, forAllChildrenBreakable, forAllChildrenMapped, getChildCount, getChildren, hasChildren, hasNoChildren

Field Detail

DEFAULT_IGNORABLE_WHITESPACE

public static final boolean DEFAULT_IGNORABLE_WHITESPACE

By default the text is not ignorable whitespaces

See Also:

Constant Field Values

DEFAULT_ESCAPE

public static final boolean DEFAULT_ESCAPE

By default the text should be XML escaped when emitting to a file etc.

See Also:

Constant Field Values

Constructor Detail

MicroText

public MicroText(@Nonnull
                 char[] aChars,
                 @Nonnegative
                 int nOfs,
                 @Nonnegative
                 int nLen,
                 boolean bIgnorableWhitespace)

MicroText

public MicroText(@Nullable
                 CharSequence sText)

MicroText

public MicroText(@Nullable
                 CharSequence sText,
                 boolean bIgnorableWhitespace)

Method Detail

getType

@Nonnull
public EMicroNodeType getType()

Specified by:

getType in interface IMicroNode

Returns:

The node type. Never null.

getNodeName

@Nonnull
 @Nonempty
public String getNodeName()

Specified by:

getNodeName in interface IMicroNode

Returns:

Just an abstract name that depends on the implementing class. For IMicroElement nodes this is the same as the tag name.

getNodeValue

@Nonnull
public String getNodeValue()

Specified by:

getNodeValue in interface IMicroNode

Returns:

The value of this node. This depends on the concrete implementation class. It is currently implemented for IMicroText, IMicroComment and IMicroEntityReference.

getData

@Nonnull
public CharSequence getData()

Specified by:

getData in interface IMicroDataAware

Returns:

The currently assigned character data. May not be null .

appendData

public void appendData(@Nullable
                       CharSequence sData)

Description copied from interface: IMicroDataAware

Append characters to the string.

Specified by:

appendData in interface IMicroDataAware

Parameters:

sData - The characters to be appended.

appendData

public void appendData(@Nonnull
                       char[] aChars,
                       @Nonnegative
                       int nOfs,
                       @Nonnegative
                       int nLen)

Description copied from interface: IMicroDataAware

Append characters to the string.

Specified by:

appendData in interface IMicroDataAware

Parameters:

aChars - Base character array. May not be null.

nOfs - Offset to start copying. Must be ≥ 0.

nLen - Number of chars to take. Must be ≥ 0.

appendData

public void appendData(char cChar)

Description copied from interface: IMicroDataAware

Append a character to the string.

Specified by:

appendData in interface IMicroDataAware

Parameters:

cChar - The character to append

prependData

public void prependData(@Nullable
                        CharSequence sData)

Description copied from interface: IMicroDataAware

Add characters to the beginning of the current data.

Specified by:

prependData in interface IMicroDataAware

Parameters:

sData - The characters to be added at the front.

prependData

public void prependData(@Nonnull
                        char[] aChars,
                        @Nonnegative
                        int nOfs,
                        @Nonnegative
                        int nLen)

Description copied from interface: IMicroDataAware

Add characters to the beginning of the current data.

Specified by:

prependData in interface IMicroDataAware

Parameters:

aChars - Base character array. May not be null.

nOfs - Offset to start copying. Must be ≥ 0.

nLen - Number of chars to take. Must be ≥ 0.

prependData

public void prependData(char cChar)

Description copied from interface: IMicroDataAware

Add a character to the beginning of the current data.

Specified by:

prependData in interface IMicroDataAware

Parameters:

cChar - The character to preprend

setData

public void setData(@Nullable
                    CharSequence sData)

Description copied from interface: IMicroDataAware

Change the character sequence. Any previously set characters are lost.

Specified by:

setData in interface IMicroDataAware

Parameters:

sData - The new character sequence to be set.

isElementContentWhitespace

public boolean isElementContentWhitespace()

Description copied from interface: IMicroText

Check whether the text node consists solely of whitespaces. This may be helpful in detecting XML that has been indented :)

Specified by:

isElementContentWhitespace in interface IMicroText

Returns:

true if the text node consists solely of whitespaces (blank, tab etc.).

isEscape

public boolean isEscape()

Specified by:

isEscape in interface IMicroText

Returns:

true if the content of this text node should be masked, and false if not. By default a text node should always be masked.

setEscape

@Nonnull
public MicroText setEscape(boolean bEscape)

getClone

@Nonnull
public IMicroText getClone()

Description copied from interface: IMicroText

Specified by:

getClone in interface com.helger.commons.lang.ICloneable<IMicroNode>

Specified by:

getClone in interface IMicroText

isEqualContent

public boolean isEqualContent(@Nullable
                              IMicroNode o)

Description copied from interface: IMicroNode

As instances of this class may not implement equals/hashCode we need a way to determine, if 2 nodes are equal by content.

Specified by:

isEqualContent in interface IMicroNode

Parameters:

o - The node to compare to this.

Returns:

true if the nodes are of the same type and the same content, false otherwise.

toString

public String toString()

Overrides:

toString in class AbstractMicroNode