com.helger.xml.microdom

Class MicroEntityReference

java.lang.Object

com.helger.xml.microdom.AbstractMicroNode

com.helger.xml.microdom.MicroEntityReference

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>, com.helger.commons.name.IHasName, IMicroEntityReference, IMicroNode, Serializable

@Immutable
public final class MicroEntityReference
extends AbstractMicroNode
implements IMicroEntityReference

Default implementation of the IMicroEntityReference interface.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MicroEntityReference(String sName)

Method Summary

Modifier and Type	Method and Description
IMicroEntityReference	getClone()
String	getName()
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.
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, appendChildren, appendChildren, 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

Methods inherited from interface com.helger.commons.name.IHasName

getComparatorCollating, getComparatorName

Constructor Detail

MicroEntityReference

public MicroEntityReference(@Nonnull @Nonempty
                            String sName)

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
 @Nonempty
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.

getName

@Nonnull
 @Nonempty
public String getName()

Specified by:

getName in interface com.helger.commons.name.IHasName

Specified by:

getName in interface IMicroEntityReference

getClone

@Nonnull
public IMicroEntityReference getClone()

Description copied from interface: IMicroEntityReference

Specified by:

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

Specified by:

getClone in interface IMicroEntityReference

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