com.helger.commons.microdom

Class MicroElement

java.lang.Object

com.helger.commons.microdom.AbstractMicroNode

com.helger.commons.microdom.AbstractMicroNodeWithChildren

com.helger.commons.microdom.MicroElement

All Implemented Interfaces:

IHasChildren<IMicroNode>, IHasChildrenSorted<IMicroNode>, IHasParent<IMicroNode>, ICloneable<IMicroNode>, IMicroElement, IMicroNode, IMicroNodeWithChildren, Serializable

public final class MicroElement
extends AbstractMicroNodeWithChildren
implements IMicroElement

Default implementation of the IMicroElement interface.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ICommonsOrderedSet<String>	getAllAttributeNames() Get a set of all attribute names.
ICommonsList<? extends IMicroAttribute>	getAllAttributeObjs() Get a list of all attributes.
ICommonsOrderedSet<IMicroQName>	getAllAttributeQNames() Get a set of all attribute names.
ICommonsList<String>	getAllAttributeValues() Get a set of all attribute values.
ICommonsList<IMicroElement>	getAllChildElements() Get a list of all direct child elements.
ICommonsList<IMicroElement>	getAllChildElements(String sTagName) Get a list of all direct child elements having the specified tag name.
ICommonsList<IMicroElement>	getAllChildElements(String sNamespaceURI, String sLocalName) Get a list of all direct child elements having the specified namespace and the specified tag name.
ICommonsList<IMicroElement>	getAllChildElementsRecursive() Recursively get all child elements.
ICommonsOrderedMap<IMicroQName,String>	getAllQAttributes() Get a map of all fully qualified attribute names and values.
int	getAttributeCount()
Iterator<? extends IMicroAttribute>	getAttributeIterator() Get an iterator over all attributes.
MicroAttribute	getAttributeObj(IMicroQName aQName) Get the attribute object with the specified qualified name.
MicroAttribute	getAttributeObj(String sAttrName) Get the attribute object with the specified name.
MicroAttribute	getAttributeObj(String sNamespaceURI, String sAttrName) Get the attribute object with the specified namespace URI and local name.
String	getAttributeValue(IMicroQName aAttrName) Get the attribute value of the given attribute name.
String	getAttributeValue(String sAttrName) Get the attribute value of the given attribute name.
String	getAttributeValue(String sNamespaceURI, String sAttrName) Get the attribute value of the given attribute name.
<DSTTYPE> DSTTYPE	getAttributeValueWithConversion(IMicroQName aAttrName, Class<DSTTYPE> aDstClass) Get the attribute value of the given attribute name.
<DSTTYPE> DSTTYPE	getAttributeValueWithConversion(String sAttrName, Class<DSTTYPE> aDstClass) Get the attribute value of the given attribute name.
<DSTTYPE> DSTTYPE	getAttributeValueWithConversion(String sNamespaceURI, String sAttrName, Class<DSTTYPE> aDstClass) Get the attribute value of the given attribute name.
int	getChildElementCount()
IMicroElement	getClone()
IMicroElement	getFirstChildElement() Get the first child element of this element.
IMicroElement	getFirstChildElement(String sTagName) Get the first child element with the given tag name.
IMicroElement	getFirstChildElement(String sNamespaceURI, String sLocalName) Get the first child element with the given tag name and the given namespace.
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	hasAttribute(String sAttrName) Check if this element has an attribute with the specified name.
boolean	hasAttribute(String sNamespaceURI, String sAttrName) Check if this element has an attribute with the specified name.
boolean	hasAttributes()
boolean	hasChildElements() Check if this element has at least one child element.
boolean	hasChildElements(String sTagName) Check if this element has at least one child element with the specified tag name.
boolean	hasChildElements(String sNamespaceURI, String sLocalName) Check if this element has at least one child element with the specified namespace URI and tag name.
boolean	hasNamespaceURI() Check if this element has a specified namespace URI.
boolean	hasNamespaceURI(String sNamespaceURI) Check if this element has the specified namespace URI.
boolean	hasNoAttributes()
boolean	hasNoNamespaceURI() Check if this element has no namespace URI.
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.
EChange	removeAllAttributes() Remove all attributes from this element
EChange	removeAttribute(IMicroQName aAttrName) Remove the attribute with the given name.
EChange	removeAttribute(String sAttrName) Remove the attribute with the given name.
EChange	removeAttribute(String sNamespaceURI, String sAttrName) Remove the attribute with the given name.
IMicroElement	setAttribute(IMicroQName aAttrName, boolean bAttrValue) Set an attribute value of this element.
MicroElement	setAttribute(IMicroQName aAttrName, IHasAttributeValue aAttrValueProvider) Set an attribute value of this element.
IMicroElement	setAttribute(IMicroQName aAttrName, int nAttrValue) Set an attribute value of this element.
IMicroElement	setAttribute(IMicroQName aAttrName, long nAttrValue) Set an attribute value of this element.
MicroElement	setAttribute(IMicroQName aAttrName, String sAttrValue) Set an attribute value of this element.
IMicroElement	setAttribute(String sAttrName, boolean bAttrValue) Set an attribute value of this element.
MicroElement	setAttribute(String sAttrName, IHasAttributeValue aAttrValueProvider) Set an attribute value of this element.
IMicroElement	setAttribute(String sAttrName, int nAttrValue) Set an attribute value of this element.
IMicroElement	setAttribute(String sAttrName, long nAttrValue) Set an attribute value of this element.
MicroElement	setAttribute(String sAttrName, String sAttrValue) Set an attribute value of this element.
IMicroElement	setAttribute(String sNamespaceURI, String sAttrName, boolean bAttrValue) Set an attribute value of this element.
MicroElement	setAttribute(String sNamespaceURI, String sAttrName, IHasAttributeValue aAttrValueProvider) Set an attribute value of this element.
IMicroElement	setAttribute(String sNamespaceURI, String sAttrName, int nAttrValue) Set an attribute value of this element.
IMicroElement	setAttribute(String sNamespaceURI, String sAttrName, long nAttrValue) Set an attribute value of this element.
MicroElement	setAttribute(String sNamespaceURI, String sAttrName, String sAttrValue) Set an attribute value of this element.
IMicroElement	setAttributeWithConversion(IMicroQName aAttrName, Object aAttrValue) Set an attribute value of this element.
IMicroElement	setAttributeWithConversion(String sAttrName, Object aAttrValue) Set an attribute value of this element.
IMicroElement	setAttributeWithConversion(String sNamespaceURI, String sAttrName, Object aAttrValue) Set an attribute value of this element.
EChange	setNamespaceURI(String sNamespaceURI) Set a new namespace URI for this element.
String	toString()

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

getAllChildren, getAllChildrenRecursive, getChildAtIndex, getChildCount, getFirstChild, getLastChild, getTextContent, getTextContentWithConversion, hasChildren, onAppendChild, onInsertAfter, onInsertAtIndex, onInsertBefore, onRemoveAllChildren, onRemoveChild, onRemoveChildAtIndex

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

appendCDATA, appendCDATA, appendCDATAWithConversion, appendChild, appendComment, appendComment, appendCommentWithConversion, appendContainer, appendElement, appendElement, appendEntityReference, appendIgnorableWhitespaceText, appendIgnorableWhitespaceText, appendProcessingInstruction, appendText, appendText, appendTextWithConversion, detachFromParent, getAllEventTargets, getAllEventTargets, getNextSibling, getParent, getParentElementWithName, getParentElementWithName, getPreviousSibling, hasParent, insertAfter, insertAtIndex, insertBefore, isCDATA, isComment, isContainer, isDocument, isDocumentType, isElement, isEntityReference, isProcessingInstruction, isText, onEvent, 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.helger.commons.microdom.IMicroNodeWithChildren

getTextContent, getTextContentTrimmed, getTextContentWithConversion

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

appendCDATA, appendCDATA, appendCDATA, appendCDATAWithConversion, appendChild, appendComment, appendComment, appendComment, appendCommentWithConversion, appendContainer, appendElement, appendElement, appendEntityReference, appendIgnorableWhitespaceText, appendIgnorableWhitespaceText, appendIgnorableWhitespaceText, appendProcessingInstruction, appendText, appendText, appendText, appendTextWithConversion, detachFromParent, getAllChildren, getAllChildrenRecursive, getAllEventTargets, getAllEventTargets, getFirstChild, getLastChild, getNextSibling, getNodeValue, 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.helger.commons.hierarchy.IHasChildrenSorted

getChildAtIndex

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

getChildCount, 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.

hasAttributes

public boolean hasAttributes()

Specified by:

hasAttributes in interface IMicroElement

Returns:

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

hasNoAttributes

public boolean hasNoAttributes()

Specified by:

hasNoAttributes in interface 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 IMicroElement

Returns:

The number of assigned attributes. Always ≥ 0.

getAllAttributeObjs

@Nullable
 @ReturnsMutableCopy
public ICommonsList<? extends IMicroAttribute> getAllAttributeObjs()

Description copied from interface: IMicroElement

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

Specified by:

getAllAttributeObjs in interface IMicroElement

Returns:

May be null.

getAttributeIterator

@Nonnull
public Iterator<? extends IMicroAttribute> getAttributeIterator()

Description copied from interface: IMicroElement

Get an iterator over all attributes.

Specified by:

getAttributeIterator in interface IMicroElement

Returns:

Never null.

getAllQAttributes

@Nullable
 @ReturnsMutableCopy
public ICommonsOrderedMap<IMicroQName,String> getAllQAttributes()

Description copied from interface: IMicroElement

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

Specified by:

getAllQAttributes in interface IMicroElement

Returns:

May be null.

getAllAttributeNames

@Nullable
 @ReturnsMutableCopy
public ICommonsOrderedSet<String> getAllAttributeNames()

Description copied from interface: IMicroElement

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

Specified by:

getAllAttributeNames in interface IMicroElement

Returns:

May be null.

getAllAttributeQNames

@Nullable
 @ReturnsMutableCopy
public ICommonsOrderedSet<IMicroQName> getAllAttributeQNames()

Description copied from interface: IMicroElement

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

Specified by:

getAllAttributeQNames in interface IMicroElement

Returns:

May be null.

getAllAttributeValues

@Nullable
 @ReturnsMutableCopy
public ICommonsList<String> getAllAttributeValues()

Description copied from interface: IMicroElement

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

Specified by:

getAllAttributeValues in interface IMicroElement

Returns:

May be null.

getAttributeObj

@Nullable
public MicroAttribute getAttributeObj(@Nullable
                                                 String sAttrName)

Description copied from interface: IMicroElement

Get the attribute object with the specified name.

Specified by:

getAttributeObj in interface IMicroElement

Parameters:

sAttrName - The attribute locale name to query. May be null.

Returns:

null of no such attribute object exists.

getAttributeObj

@Nullable
public MicroAttribute getAttributeObj(@Nullable
                                                 String sNamespaceURI,
                                                 @Nullable
                                                 String sAttrName)

Description copied from interface: IMicroElement

Get the attribute object with the specified namespace URI and local name.

Specified by:

getAttributeObj in interface IMicroElement

Parameters:

sNamespaceURI - Namespace URI to use. May be null.

sAttrName - The attribute locale name to query. May be null.

Returns:

null of no such attribute object exists.

getAttributeObj

@Nullable
public MicroAttribute getAttributeObj(@Nullable
                                                 IMicroQName aQName)

Description copied from interface: IMicroElement

Get the attribute object with the specified qualified name.

Specified by:

getAttributeObj in interface IMicroElement

Parameters:

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

Returns:

null of no such attribute object exists.

getAttributeValue

@Nullable
public String getAttributeValue(@Nullable
                                           String sAttrName)

Description copied from interface: IMicroElement

Get the attribute value of the given attribute name. If this element has no such attribute, null is returned.

Specified by:

getAttributeValue in interface IMicroElement

Parameters:

sAttrName - The attribute name to retrieve the value of.

Returns:

The assigned attribute value or null.

getAttributeValue

@Nullable
public String getAttributeValue(@Nullable
                                           String sNamespaceURI,
                                           @Nullable
                                           String sAttrName)

Description copied from interface: IMicroElement

Get the attribute value of the given attribute name. If this element has no such attribute, null is returned.

Specified by:

getAttributeValue in interface IMicroElement

Parameters:

sNamespaceURI - Namespace URI to use. May be null.

sAttrName - The attribute name to retrieve the value of.

Returns:

The assigned attribute value or null.

getAttributeValue

@Nullable
public String getAttributeValue(@Nullable
                                           IMicroQName aAttrName)

Description copied from interface: IMicroElement

Get the attribute value of the given attribute name. If this element has no such attribute, null is returned.

Specified by:

getAttributeValue in interface IMicroElement

Parameters:

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

Returns:

The assigned attribute value or null.

getAttributeValueWithConversion

@Nullable
public <DSTTYPE> DSTTYPE getAttributeValueWithConversion(@Nullable
                                                                    String sAttrName,
                                                                    @Nonnull
                                                                    Class<DSTTYPE> aDstClass)

Description copied from interface: IMicroElement

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 IMicroElement

Type Parameters:

DSTTYPE - Destination type

Parameters:

sAttrName - The attribute name to retrieve the value of.

aDstClass - The destination class.

Returns:

The assigned attribute value or null.

getAttributeValueWithConversion

@Nullable
public <DSTTYPE> DSTTYPE getAttributeValueWithConversion(@Nullable
                                                                    String sNamespaceURI,
                                                                    @Nullable
                                                                    String sAttrName,
                                                                    @Nonnull
                                                                    Class<DSTTYPE> aDstClass)

Description copied from interface: IMicroElement

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 IMicroElement

Type Parameters:

DSTTYPE - Destination type

Parameters:

sNamespaceURI - Namespace URI to use. May be null.

sAttrName - The attribute name to retrieve the value of.

aDstClass - The destination class.

Returns:

The assigned attribute value or null.

getAttributeValueWithConversion

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

Description copied from interface: IMicroElement

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 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
                            String sAttrName)

Description copied from interface: IMicroElement

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

Specified by:

hasAttribute in interface IMicroElement

Parameters:

sAttrName - The attribute name to check.

Returns:

true if such an attribute is present, false otherwise

hasAttribute

public boolean hasAttribute(@Nullable
                            String sNamespaceURI,
                            @Nullable
                            String sAttrName)

Description copied from interface: IMicroElement

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

Specified by:

hasAttribute in interface IMicroElement

Parameters:

sNamespaceURI - Namespace URI to use. May be null.

sAttrName - The attribute name to check.

Returns:

true if such an attribute is present, false otherwise

hasAttribute

public boolean hasAttribute(@Nullable
                            IMicroQName aAttrName)

Description copied from interface: IMicroElement

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

Specified by:

hasAttribute in interface 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 EChange removeAttribute(@Nullable
                                         String sAttrName)

Description copied from interface: IMicroElement

Remove the attribute with the given name.

Specified by:

removeAttribute in interface IMicroElement

Parameters:

sAttrName - The 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.

removeAttribute

@Nonnull
public EChange removeAttribute(@Nullable
                                         String sNamespaceURI,
                                         @Nullable
                                         String sAttrName)

Description copied from interface: IMicroElement

Remove the attribute with the given name.

Specified by:

removeAttribute in interface IMicroElement

Parameters:

sNamespaceURI - Namespace URI to use. May be null.

sAttrName - The 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.

removeAttribute

@Nonnull
public EChange removeAttribute(@Nullable
                                         IMicroQName aAttrName)

Description copied from interface: IMicroElement

Remove the attribute with the given name.

Specified by:

removeAttribute in interface 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 @Nonempty
                                           String sAttrName,
                                           @Nullable
                                           String sAttrValue)

Description copied from interface: IMicroElement

Set an attribute value of this element.

Specified by:

setAttribute in interface IMicroElement

Parameters:

sAttrName - Name of the attribute. May neither be null nor empty.

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

Returns:

this

setAttribute

@Nonnull
public MicroElement setAttribute(@Nullable
                                           String sNamespaceURI,
                                           @Nonnull @Nonempty
                                           String sAttrName,
                                           @Nullable
                                           String sAttrValue)

Description copied from interface: IMicroElement

Set an attribute value of this element.

Specified by:

setAttribute in interface IMicroElement

Parameters:

sNamespaceURI - Namespace URI to use. May be null.

sAttrName - Name of the attribute. May neither be null nor empty.

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

Returns:

this

setAttribute

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

Description copied from interface: IMicroElement

Set an attribute value of this element.

Specified by:

setAttribute in interface 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

setAttribute

@Nonnull
public MicroElement setAttribute(@Nonnull
                                           String sAttrName,
                                           @Nonnull
                                           IHasAttributeValue aAttrValueProvider)

Description copied from interface: IMicroElement

Set an attribute value of this element.

Specified by:

setAttribute in interface IMicroElement

Parameters:

sAttrName - Name of the attribute. May neither be null nor empty.

aAttrValueProvider - The attribute value provider. May not be null. If the contained attribute value is null the attribute is removed (if present)

Returns:

this

setAttribute

@Nonnull
public MicroElement setAttribute(@Nullable
                                           String sNamespaceURI,
                                           @Nonnull
                                           String sAttrName,
                                           @Nonnull
                                           IHasAttributeValue aAttrValueProvider)

Description copied from interface: IMicroElement

Set an attribute value of this element.

Specified by:

setAttribute in interface IMicroElement

Parameters:

sNamespaceURI - Namespace URI to use. May be null.

sAttrName - Name of the attribute. May neither be null nor empty.

aAttrValueProvider - The attribute value provider. May not be null. If the contained attribute value is null the attribute is removed (if present)

Returns:

this

setAttribute

@Nonnull
public MicroElement setAttribute(@Nonnull
                                           IMicroQName aAttrName,
                                           @Nonnull
                                           IHasAttributeValue aAttrValueProvider)

Description copied from interface: IMicroElement

Set an attribute value of this element.

Specified by:

setAttribute in interface IMicroElement

Parameters:

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

aAttrValueProvider - The attribute value provider. May not be null. If the contained attribute value is null the attribute is removed (if present)

Returns:

this

setAttribute

@Nonnull
public IMicroElement setAttribute(@Nonnull
                                            String sAttrName,
                                            boolean bAttrValue)

Description copied from interface: IMicroElement

Set an attribute value of this element. This is a shortcut for setAttribute(sAttrName, Boolean.toString (nValue)). That means, that the serialized value of the attribute is either true or false. If you need something else (like "yes" or "no") don't use this method.

Specified by:

setAttribute in interface IMicroElement

Parameters:

sAttrName - Name of the attribute. May neither be null nor empty.

bAttrValue - The new value to be set.

Returns:

this

setAttribute

@Nonnull
public IMicroElement setAttribute(@Nullable
                                            String sNamespaceURI,
                                            @Nonnull
                                            String sAttrName,
                                            boolean bAttrValue)

Description copied from interface: IMicroElement

Set an attribute value of this element. This is a shortcut for setAttribute(sNamespaceURI, sAttrName, Boolean.toString (nValue)) . That means, that the serialized value of the attribute is either true or false. If you need something else (like "yes" or "no") don't use this method.

Specified by:

setAttribute in interface IMicroElement

Parameters:

sNamespaceURI - Namespace URI to use. May be null.

sAttrName - Name of the attribute. May neither be null nor empty.

bAttrValue - The new value to be set.

Returns:

this

setAttribute

@Nonnull
public IMicroElement setAttribute(@Nonnull
                                            IMicroQName aAttrName,
                                            boolean bAttrValue)

Description copied from interface: IMicroElement

Set an attribute value of this element. This is a shortcut for setAttribute(aAttrName, Boolean.toString (nValue)). That means, that the serialized value of the attribute is either true or false. If you need something else (like "yes" or "no") don't use this method.

Specified by:

setAttribute in interface IMicroElement

Parameters:

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

bAttrValue - The new value to be set.

Returns:

this

setAttribute

@Nonnull
public IMicroElement setAttribute(@Nonnull
                                            String sAttrName,
                                            int nAttrValue)

Description copied from interface: IMicroElement

Set an attribute value of this element. This is a shortcut for setAttribute(sAttrName, Integer.toString (nValue)).

Specified by:

setAttribute in interface IMicroElement

Parameters:

sAttrName - Name of the attribute. May neither be null nor empty.

nAttrValue - The new value to be set.

Returns:

this

setAttribute

@Nonnull
public IMicroElement setAttribute(@Nullable
                                            String sNamespaceURI,
                                            @Nonnull
                                            String sAttrName,
                                            int nAttrValue)

Description copied from interface: IMicroElement

Set an attribute value of this element. This is a shortcut for setAttribute(sNamespaceURI, sAttrName, Integer.toString (nValue)) .

Specified by:

setAttribute in interface IMicroElement

Parameters:

sNamespaceURI - Namespace URI to use. May be null.

sAttrName - Name of the attribute. May neither be null nor empty.

nAttrValue - The new value to be set.

Returns:

this

setAttribute

@Nonnull
public IMicroElement setAttribute(@Nonnull
                                            IMicroQName aAttrName,
                                            int nAttrValue)

Description copied from interface: IMicroElement

Set an attribute value of this element. This is a shortcut for setAttribute(aAttrName, Integer.toString (nValue)).

Specified by:

setAttribute in interface IMicroElement

Parameters:

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

nAttrValue - The new value to be set.

Returns:

this

setAttribute

@Nonnull
public IMicroElement setAttribute(@Nonnull
                                            String sAttrName,
                                            long nAttrValue)

Description copied from interface: IMicroElement

Set an attribute value of this element. This is a shortcut for setAttribute(name, Long.toString (nValue)).

Specified by:

setAttribute in interface IMicroElement

Parameters:

sAttrName - Name of the attribute. May neither be null nor empty.

nAttrValue - The new value to be set.

Returns:

this

setAttribute

@Nonnull
public IMicroElement setAttribute(@Nullable
                                            String sNamespaceURI,
                                            @Nonnull
                                            String sAttrName,
                                            long nAttrValue)

Description copied from interface: IMicroElement

Set an attribute value of this element. This is a shortcut for setAttribute(name, Long.toString (nValue)).

Specified by:

setAttribute in interface IMicroElement

Parameters:

sNamespaceURI - Namespace URI to use. May be null.

sAttrName - Name of the attribute. May neither be null nor empty.

nAttrValue - The new value to be set.

Returns:

this

setAttribute

@Nonnull
public IMicroElement setAttribute(@Nonnull
                                            IMicroQName aAttrName,
                                            long nAttrValue)

Description copied from interface: IMicroElement

Set an attribute value of this element. This is a shortcut for setAttribute(name, Long.toString (nValue)).

Specified by:

setAttribute in interface IMicroElement

Parameters:

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

nAttrValue - The new value to be set.

Returns:

this

setAttributeWithConversion

@Nonnull
public IMicroElement setAttributeWithConversion(@Nonnull
                                                          String sAttrName,
                                                          @Nullable
                                                          Object aAttrValue)

Description copied from interface: IMicroElement

Set an attribute value of this element. If the type of the value is not String, the TypeConverter is invoked to convert it to a String object.

Specified by:

setAttributeWithConversion in interface IMicroElement

Parameters:

sAttrName - Name of the attribute. May neither be null nor empty.

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

Returns:

this

setAttributeWithConversion

@Nonnull
public IMicroElement setAttributeWithConversion(@Nullable
                                                          String sNamespaceURI,
                                                          @Nonnull
                                                          String sAttrName,
                                                          @Nullable
                                                          Object aAttrValue)

Description copied from interface: IMicroElement

Set an attribute value of this element. If the type of the value is not String, the TypeConverter is invoked to convert it to a String object.

Specified by:

setAttributeWithConversion in interface IMicroElement

Parameters:

sNamespaceURI - Namespace URI to use. May be null.

sAttrName - Name of the attribute. May neither be null nor empty.

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

Returns:

this

setAttributeWithConversion

@Nonnull
public IMicroElement setAttributeWithConversion(@Nonnull
                                                          IMicroQName aAttrName,
                                                          @Nullable
                                                          Object aAttrValue)

Description copied from interface: IMicroElement

Set an attribute value of this element. If the type of the value is not String, the TypeConverter is invoked to convert it to a String object.

Specified by:

setAttributeWithConversion in interface IMicroElement

Parameters:

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

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

Returns:

this

removeAllAttributes

@Nonnull
public EChange removeAllAttributes()

Description copied from interface: IMicroElement

Remove all attributes from this element

Specified by:

removeAllAttributes in interface 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 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

hasNamespaceURI

public boolean hasNamespaceURI()

Description copied from interface: IMicroElement

Check if this element has a specified namespace URI.

Specified by:

hasNamespaceURI in interface IMicroElement

Returns:

true if this element has a specified namespace URI, false otherwise

hasNoNamespaceURI

public boolean hasNoNamespaceURI()

Description copied from interface: IMicroElement

Check if this element has no namespace URI.

Specified by:

hasNoNamespaceURI in interface IMicroElement

Returns:

true if this element has no namespace URI, false otherwise

hasNamespaceURI

public boolean hasNamespaceURI(@Nullable
                               String sNamespaceURI)

Description copied from interface: IMicroElement

Check if this element has the specified namespace URI.

Specified by:

hasNamespaceURI in interface IMicroElement

Parameters:

sNamespaceURI - The namespace URI to check. May not be null.

Returns:

true if this element has the specified namespace URI, false otherwise

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.

getChildElementCount

@Nonnegative
public int getChildElementCount()

Specified by:

getChildElementCount in interface IMicroElement

Returns:

The number of all direct child elements. Always ≥ 0.

getAllChildElements

@Nonnull
 @ReturnsMutableCopy
public ICommonsList<IMicroElement> getAllChildElements()

Description copied from interface: IMicroElement

Get a list of all direct child elements. Text nodes and other other child nodes are not returned with this call. Micro container children are inlined.

Specified by:

getAllChildElements in interface IMicroElement

Returns:

Never be null.

getAllChildElements

@Nonnull
 @ReturnsMutableCopy
public ICommonsList<IMicroElement> getAllChildElements(@Nullable
                                                                                       String sTagName)

Description copied from interface: IMicroElement

Get a list of all direct child elements having the specified tag name. Micro container children are inlined.

Specified by:

getAllChildElements in interface IMicroElement

Parameters:

sTagName - The tag name to check. May be null.

Returns:

Never be null.

getAllChildElements

@Nonnull
 @ReturnsMutableCopy
public ICommonsList<IMicroElement> getAllChildElements(@Nullable
                                                                                       String sNamespaceURI,
                                                                                       @Nullable
                                                                                       String sLocalName)

Description copied from interface: IMicroElement

Get a list of all direct child elements having the specified namespace and the specified tag name. Micro container children are inlined.

Specified by:

getAllChildElements in interface IMicroElement

Parameters:

sNamespaceURI - The namespace URI to check. May be null.

sLocalName - The tag name to check. May be null.

Returns:

Never be null.

getAllChildElementsRecursive

@Nonnull
 @ReturnsMutableCopy
public 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.

hasChildElements

public boolean hasChildElements()

Description copied from interface: IMicroElement

Check if this element has at least one child element. Micro container children are also checked.

Specified by:

hasChildElements in interface IMicroElement

Returns:

true if this element has at least one child element

hasChildElements

public boolean hasChildElements(@Nullable
                                String sTagName)

Description copied from interface: IMicroElement

Check if this element has at least one child element with the specified tag name. Micro container children are also checked.

Specified by:

hasChildElements in interface IMicroElement

Parameters:

sTagName - The tag name to check. May be null.

Returns:

true if this element has at least one child element with the specified tag name

hasChildElements

public boolean hasChildElements(@Nullable
                                String sNamespaceURI,
                                @Nullable
                                String sLocalName)

Description copied from interface: IMicroElement

Check if this element has at least one child element with the specified namespace URI and tag name. Micro container children are also checked.

Specified by:

hasChildElements in interface IMicroElement

Parameters:

sNamespaceURI - The namespace URI to check. May be null.

sLocalName - The tag name to check. May be null.

Returns:

true if this element has at least one child element with the specified namespace URI and tag name

getFirstChildElement

@Nullable
public IMicroElement getFirstChildElement()

Description copied from interface: IMicroElement

Get the first child element of this element. Micro container children are also checked.

Specified by:

getFirstChildElement in interface IMicroElement

Returns:

The first child element or null if this element has no child element.

getFirstChildElement

@Nullable
public IMicroElement getFirstChildElement(@Nullable
                                                     String sTagName)

Description copied from interface: IMicroElement

Get the first child element with the given tag name. Micro container children are also checked.

Specified by:

getFirstChildElement in interface IMicroElement

Parameters:

sTagName - The tag name of the element to search. May be null.

Returns:

null if no such child element is present

getFirstChildElement

@Nullable
public IMicroElement getFirstChildElement(@Nullable
                                                     String sNamespaceURI,
                                                     @Nullable
                                                     String sLocalName)

Description copied from interface: IMicroElement

Get the first child element with the given tag name and the given namespace. Micro container children are also checked.

Specified by:

getFirstChildElement in interface IMicroElement

Parameters:

sNamespaceURI - The namespace URL to search.

sLocalName - The tag name of the element to search.

Returns:

null if no such child element is present

getClone

@Nonnull
public IMicroElement getClone()

Description copied from interface: IMicroElement

Specified by:

getClone in interface ICloneable<IMicroNode>

Specified by:

getClone in interface IMicroElement

Specified by:

getClone in interface IMicroNodeWithChildren

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

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