com.phloc.commons.microdom.impl

Class MicroComment

java.lang.Object

com.phloc.commons.microdom.impl.AbstractMicroNode

com.phloc.commons.microdom.impl.MicroComment

All Implemented Interfaces:

ICloneable<IMicroNode>, IMicroComment, IMicroDataAware, IMicroNode, IHasChildren<IMicroNode>, IHasChildrenSorted<IMicroNode>, IHasParent<IMicroNode>, Serializable

public final class MicroComment
extends AbstractMicroNode
implements IMicroComment

Default implementation of the IMicroComment interface.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MicroComment(char[] aChars, int nOfs, int nLen)
MicroComment(CharSequence sText)

Method Summary

Methods

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.
IMicroComment	getClone()
CharSequence	getData()
String	getNodeName()
String	getNodeValue()
EMicroNodeType	getType()
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.
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.
String	toString()

Methods inherited from class com.phloc.commons.microdom.impl.AbstractMicroNode

appendCDATA, appendCDATA, appendCDATA, appendCDATAWithConversion, appendChild, appendComment, appendComment, appendComment, appendCommentWithConversion, appendContainer, appendElement, appendElement, appendElement, appendElement, appendEntityReference, appendIgnorableWhitespaceText, appendIgnorableWhitespaceText, appendIgnorableWhitespaceText, appendProcessingInstruction, appendText, appendText, appendText, appendTextWithConversion, detachFromParent, getAllChildrenRecursive, getChildAtIndex, getChildCount, getChildren, getFirstChild, getLastChild, getNextSibling, getParent, getParentElementWithName, getParentElementWithName, getPreviousSibling, hasChildren, hasParent, insertAfter, insertAtIndex, insertBefore, isCDATA, isComment, isContainer, isDocument, isDocumentType, isElement, isEntityReference, isProcessingInstruction, isText, onAppendChild, onEvent, onInsertAfter, onInsertAtIndex, onInsertBefore, onRemoveAllChildren, onRemoveChild, onRemoveChildAtIndex, registerEventTarget, removeAllChildren, removeChild, removeChildAtIndex, replaceChild, unregisterEventTarget

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.phloc.commons.microdom.IMicroNode

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

Methods inherited from interface com.phloc.commons.parent.IHasChildrenSorted

getChildAtIndex

Methods inherited from interface com.phloc.commons.parent.IHasChildren

getChildCount

Constructor Detail

MicroComment

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

MicroComment

public MicroComment(@Nullable
            CharSequence sText)

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.

getNodeValue

@Nonnull
public String getNodeValue()

Specified by:

getNodeValue in interface IMicroNode

Overrides:

getNodeValue in class AbstractMicroNode

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.

getClone

@Nonnull
public IMicroComment getClone()

Description copied from interface: IMicroComment

Specified by:

getClone in interface ICloneable<IMicroNode>

Specified by:

getClone in interface IMicroComment

Returns:

A 100% deep-copy of the implementing class.

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