com.helger.xml.microdom

Class MicroElement

java.lang.Object

com.helger.xml.microdom.AbstractMicroNode

com.helger.xml.microdom.AbstractMicroNodeWithChildren

com.helger.xml.microdom.MicroElement

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>, IMicroAttributeContainer<IMicroElement>, IMicroElement, IMicroNode, IMicroNodeWithChildren

public final class MicroElement
extends AbstractMicroNodeWithChildren
implements IMicroElement

Default implementation of the IMicroElement interface.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
MicroElement(String sTagName)
MicroElement(String sNamespaceURI, String sTagName)

Method Summary

Modifier and Type	Method and Description
boolean	containsAnyChildElement(Predicate<? super IMicroElement> aFilter) Check if this element has at least one direct child element that matches the provided filter.
void	forAllAttributes(BiConsumer<? super IMicroQName,? super String> aConsumer) Iterate all attribute objects.
void	forAllAttributes(Consumer<? super IMicroAttribute> aConsumer) Iterate all attribute objects.
void	forAllAttributes(com.helger.commons.functional.ITriConsumer<? super String,? super String,? super String> aConsumer) Iterate all attribute objects.
void	forAllChildElements(Predicate<? super IMicroElement> aFilter, Consumer<? super IMicroElement> aConsumer)
com.helger.commons.state.EContinue	forAllChildElementsBreakable(Predicate<? super IMicroElement> aFilter, Function<? super IMicroElement,com.helger.commons.state.EContinue> aConsumer)
com.helger.commons.collection.impl.ICommonsList<MicroAttribute>	getAllAttributeObjs() Get a list of all attributes.
com.helger.commons.collection.impl.ICommonsOrderedSet<IMicroQName>	getAllAttributeQNames() Get a set of all attribute names.
com.helger.commons.collection.impl.ICommonsList<IMicroElement>	getAllChildElementsRecursive() Recursively get all child elements.
com.helger.commons.collection.impl.ICommonsOrderedMap<IMicroQName,String>	getAllQAttributes() Get a map of all fully qualified attribute names and values.
int	getAttributeCount()
MicroAttribute	getAttributeObj(IMicroQName aQName) Get the attribute object with the specified qualified name.
Iterable<MicroAttribute>	getAttributeObjs() Get a iterable objects of all attributes.
<DSTTYPE> DSTTYPE	getAttributeValueWithConversion(IMicroQName aAttrName, Class<DSTTYPE> aDstClass) Get the attribute value of the given attribute name.
IMicroElement	getClone()
IMicroElement	getFirstChildElement(Predicate<? super IMicroElement> aFilter)
String	getLocalName() Get the local name of the element.
String	getNamespaceURI() Get the namespace URI of this element
String	getNodeName()
String	getTagName() Get the name of the tag.
EMicroNodeType	getType()
boolean	hasAttribute(IMicroQName aAttrName) Check if this element has an attribute with the specified name.
boolean	hasAttributes()
boolean	hasNoAttributes()
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.
com.helger.commons.state.EChange	removeAllAttributes() Remove all attributes from this element
com.helger.commons.state.EChange	removeAttribute(IMicroQName aAttrName) Remove the attribute with the given name.
MicroElement	setAttribute(IMicroQName aAttrName, String sAttrValue) Set an attribute value of this element.
com.helger.commons.state.EChange	setNamespaceURI(String sNamespaceURI) Set a new namespace URI for this element.
String	toString()

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

containsAnyChild, directGetAllChildren, findFirstChild, findFirstChildMapped, forAllChildren, forAllChildren, forAllChildrenBreakable, forAllChildrenMapped, getAllChildren, getChildAtIndex, getChildCount, getChildren, getFirstChild, getLastChild, getTextContent, getTextContentWithConversion, hasChildren, onAppendChild, onInsertAfter, onInsertAtIndex, onInsertBefore, onRemoveAllChildren, onRemoveChild, onRemoveChildAtIndex

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

appendChild, detachFromParent, findParentElement, getAllEventTargets, getAllEventTargets, getNextSibling, getParent, getPreviousSibling, hasParent, insertAfter, insertAtIndex, insertBefore, internalResetParentNode, internalSetParentNode, internalTriggerEvent, isCDATA, isComment, isContainer, isDocument, isDocumentType, isElement, isEntityReference, isProcessingInstruction, isText, onEvent, 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.IMicroElement

filterName, filterNamespaceURI, filterNamespaceURIAndName, forAllChildElements, forAllChildElementsBreakable, getAllChildElements, getAllChildElements, getAllChildElements, getAllChildElements, getChildElementCount, getChildElementCount, getFirstChildElement, getFirstChildElement, getFirstChildElement, hasChildElements, hasChildElements, hasChildElements, hasLocalName, hasNamespaceURI, hasNamespaceURI, hasNoNamespaceURI, hasTagName, hasTagNameIgnoreCase

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

getTextContent, getTextContentTrimmed, getTextContentWithConversion

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

getAttributeObj, getAttributeObj, getAttributeValue, getAttributeValue, getAttributeValue, getAttributeValueAsBool, getAttributeValueAsBool, getAttributeValueAsBool, getAttributeValueAsDouble, getAttributeValueAsDouble, getAttributeValueAsDouble, getAttributeValueAsFloat, getAttributeValueAsFloat, getAttributeValueAsFloat, getAttributeValueAsInt, getAttributeValueAsInt, getAttributeValueAsInt, getAttributeValueAsLong, getAttributeValueAsLong, getAttributeValueAsLong, getAttributeValueWithConversion, getAttributeValueWithConversion, hasAttribute, hasAttribute, removeAttribute, removeAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeWithConversion, setAttributeWithConversion, setAttributeWithConversion, setAttributeWithConversion, setAttributeWithConversion, setAttributeWithConversion

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, getNodeValue, 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

Constructor Detail

MicroElement

public MicroElement(@Nonnull @Nonempty
                    String sTagName)

MicroElement

public MicroElement(@Nullable
                    String sNamespaceURI,
                    @Nonnull @Nonempty
                    String sTagName)

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.

hasAttributes

public boolean hasAttributes()

Specified by:

hasAttributes in interface IMicroAttributeContainer<IMicroElement>

Returns:

true if this element has at least one attribute, false otherwise

hasNoAttributes

public boolean hasNoAttributes()

Specified by:

hasNoAttributes in interface IMicroAttributeContainer<IMicroElement>

Returns:

true if this element has no attribute, false if at least one attribute is present.

getAttributeCount

@Nonnegative
public int getAttributeCount()

Specified by:

getAttributeCount in interface IMicroAttributeContainer<IMicroElement>

Returns:

The number of assigned attributes. Always ≥ 0.

getAttributeObjs

@Nullable
 @ReturnsImmutableObject
public Iterable<MicroAttribute> getAttributeObjs()

Description copied from interface: IMicroAttributeContainer

Get a iterable objects of all attributes. Is ensured to be not null if IMicroAttributeContainer.hasAttributes() returns true.

Specified by:

getAttributeObjs in interface IMicroAttributeContainer<IMicroElement>

Returns:

May be null.

getAllAttributeObjs

@Nullable
 @ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsList<MicroAttribute> getAllAttributeObjs()

Description copied from interface: IMicroAttributeContainer

Get a list of all attributes. Is ensured to be not null if IMicroAttributeContainer.hasAttributes() returns true.

Specified by:

getAllAttributeObjs in interface IMicroAttributeContainer<IMicroElement>

Returns:

May be null.

getAllQAttributes

@Nullable
 @ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsOrderedMap<IMicroQName,String> getAllQAttributes()

Description copied from interface: IMicroAttributeContainer

Get a map of all fully qualified attribute names and values. Is ensured to be not null if IMicroAttributeContainer.hasAttributes() returns true.

Specified by:

getAllQAttributes in interface IMicroAttributeContainer<IMicroElement>

Returns:

May be null.

getAllAttributeQNames

@Nullable
 @ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsOrderedSet<IMicroQName> getAllAttributeQNames()

Description copied from interface: IMicroAttributeContainer

Get a set of all attribute names. Is ensured to be not null if IMicroAttributeContainer.hasAttributes() returns true.

Specified by:

getAllAttributeQNames in interface IMicroAttributeContainer<IMicroElement>

Returns:

May be null.

forAllAttributes

public void forAllAttributes(@Nonnull
                             Consumer<? super IMicroAttribute> aConsumer)

Description copied from interface: IMicroAttributeContainer

Iterate all attribute objects.

Specified by:

forAllAttributes in interface IMicroAttributeContainer<IMicroElement>

Parameters:

aConsumer - The consumer. May not be null. May only perform reading operations!

forAllAttributes

public void forAllAttributes(@Nonnull
                             BiConsumer<? super IMicroQName,? super String> aConsumer)

Description copied from interface: IMicroAttributeContainer

Iterate all attribute objects.

Specified by:

forAllAttributes in interface IMicroAttributeContainer<IMicroElement>

Parameters:

aConsumer - The consumer that takes the QName and the value. May not be null. May only perform reading operations!

forAllAttributes

public void forAllAttributes(@Nonnull
                             com.helger.commons.functional.ITriConsumer<? super String,? super String,? super String> aConsumer)

Description copied from interface: IMicroAttributeContainer

Iterate all attribute objects.

Specified by:

forAllAttributes in interface IMicroAttributeContainer<IMicroElement>

Parameters:

aConsumer - The consumer that takes the namespace URI, the attribute local name and the attribute value. May not be null. May only perform reading operations!

getAttributeObj

@Nullable
public MicroAttribute getAttributeObj(@Nullable
                                                 IMicroQName aQName)

Description copied from interface: IMicroAttributeContainer

Get the attribute object with the specified qualified name.

Specified by:

getAttributeObj in interface IMicroAttributeContainer<IMicroElement>

Parameters:

aQName - The qualified attribute name to check. May be null.

Returns:

null of no such attribute object exists.

getAttributeValueWithConversion

@Nullable
public <DSTTYPE> DSTTYPE getAttributeValueWithConversion(@Nullable
                                                                    IMicroQName aAttrName,
                                                                    @Nonnull
                                                                    Class<DSTTYPE> aDstClass)

Description copied from interface: IMicroAttributeContainer

Get the attribute value of the given attribute name. If this element has no such attribute, null is returned. The attribute value is converted via the TypeConverter to the desired destination class. If no such attribute is present, null is returned.

Specified by:

getAttributeValueWithConversion in interface IMicroAttributeContainer<IMicroElement>

Type Parameters:

DSTTYPE - Destination type

Parameters:

aAttrName - The attribute qualified name to retrieve the value of.

aDstClass - The destination class.

Returns:

The assigned attribute value or null.

hasAttribute

public boolean hasAttribute(@Nullable
                            IMicroQName aAttrName)

Description copied from interface: IMicroAttributeContainer

Check if this element has an attribute with the specified name.

Specified by:

hasAttribute in interface IMicroAttributeContainer<IMicroElement>

Parameters:

aAttrName - The qualified attribute name to check. May be null.

Returns:

true if such an attribute is present, false otherwise

removeAttribute

@Nonnull
public com.helger.commons.state.EChange removeAttribute(@Nullable
                                                                  IMicroQName aAttrName)

Description copied from interface: IMicroAttributeContainer

Remove the attribute with the given name.

Specified by:

removeAttribute in interface IMicroAttributeContainer<IMicroElement>

Parameters:

aAttrName - The qualified name of the attribute to be removed. May be null.

Returns:

EChange.CHANGED if the attribute was removed, EChange.UNCHANGED if no such attribute exists at this element.

setAttribute

@Nonnull
public MicroElement setAttribute(@Nonnull
                                           IMicroQName aAttrName,
                                           @Nullable
                                           String sAttrValue)

Description copied from interface: IMicroAttributeContainer

Set an attribute value of this element.

Specified by:

setAttribute in interface IMicroAttributeContainer<IMicroElement>

Parameters:

aAttrName - Qualified name of the attribute. May neither be null nor empty.

sAttrValue - If the value is null the attribute is removed (if present)

Returns:

this

removeAllAttributes

@Nonnull
public com.helger.commons.state.EChange removeAllAttributes()

Description copied from interface: IMicroAttributeContainer

Remove all attributes from this element

Specified by:

removeAllAttributes in interface IMicroAttributeContainer<IMicroElement>

Returns:

EChange.

getNamespaceURI

@Nullable
public String getNamespaceURI()

Description copied from interface: IMicroElement

Get the namespace URI of this element

Specified by:

getNamespaceURI in interface IMicroElement

Returns:

May be null if this element has no namespace URI.

setNamespaceURI

@Nonnull
public com.helger.commons.state.EChange setNamespaceURI(@Nullable
                                                                  String sNamespaceURI)

Description copied from interface: IMicroElement

Set a new namespace URI for this element.

Specified by:

setNamespaceURI in interface IMicroElement

Parameters:

sNamespaceURI - The namespace URI to be set. May be null or empty to indicate that the namespace should be removed.

Returns:

EChange

getLocalName

@Nullable
public String getLocalName()

Description copied from interface: IMicroElement

Get the local name of the element. Is the same name as returned by IMicroElement.getTagName() but it is only present, if a namespace URI is present.

Specified by:

getLocalName in interface IMicroElement

Returns:

May be null if no namespace is present.

getTagName

@Nonnull
public String getTagName()

Description copied from interface: IMicroElement

Get the name of the tag. It never contains XML schema prefixes or the like. Is the same as IMicroElement.getLocalName() if a namespace URI is present.

Specified by:

getTagName in interface IMicroElement

Returns:

May not be null.

getAllChildElementsRecursive

@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsList<IMicroElement> getAllChildElementsRecursive()

Description copied from interface: IMicroElement

Recursively get all child elements. Micro container children are inlined.

Specified by:

getAllChildElementsRecursive in interface IMicroElement

Returns:

A list containing all recursively contained elements. May not be null but empty.

containsAnyChildElement

public boolean containsAnyChildElement(@Nullable
                                       Predicate<? super IMicroElement> aFilter)

Description copied from interface: IMicroElement

Check if this element has at least one direct child element that matches the provided filter. Micro container children are also checked.

Specified by:

containsAnyChildElement in interface IMicroElement

Parameters:

aFilter - The filter to be applied. May be null.

Returns:

true if this element has at least one direct child element that matches the passed filter, false otherwise.

getFirstChildElement

@Nullable
public IMicroElement getFirstChildElement(@Nullable
                                                     Predicate<? super IMicroElement> aFilter)

Specified by:

getFirstChildElement in interface IMicroElement

forAllChildElements

public void forAllChildElements(@Nullable
                                Predicate<? super IMicroElement> aFilter,
                                @Nonnull
                                Consumer<? super IMicroElement> aConsumer)

Specified by:

forAllChildElements in interface IMicroElement

forAllChildElementsBreakable

@Nonnull
public com.helger.commons.state.EContinue forAllChildElementsBreakable(@Nullable
                                                                                 Predicate<? super IMicroElement> aFilter,
                                                                                 @Nonnull
                                                                                 Function<? super IMicroElement,com.helger.commons.state.EContinue> aConsumer)

Specified by:

forAllChildElementsBreakable in interface IMicroElement

getClone

@Nonnull
public IMicroElement getClone()

Description copied from interface: IMicroElement

Specified by:

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

Specified by:

getClone in interface IMicroElement

Specified by:

getClone in interface IMicroNodeWithChildren

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

Overrides:

isEqualContent in class AbstractMicroNodeWithChildren

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 AbstractMicroNodeWithChildren