com.helger.commons.microdom

Interface IMicroAttribute

All Superinterfaces:

ICloneable<IMicroAttribute>, Serializable

All Known Implementing Classes:

MicroAttribute

public interface IMicroAttribute
extends Serializable, ICloneable<IMicroAttribute>

Represents a single attribute within an element (=tag).

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
QName	getAsXMLQName()
QName	getAsXMLQName(String sPrefix)
String	getAttributeName() Get the name of the attribute.
IMicroQName	getAttributeQName() Get the qualified name of the attribute.
String	getAttributeValue()
IMicroAttribute	getClone()
String	getNamespaceURI() Get the namespace URI of this attribute
boolean	hasNamespaceURI() Check if this attribute has a specified namespace URI.
boolean	hasNamespaceURI(String sNamespaceURI) Check if this attribute has the specified namespace URI.
boolean	hasNoNamespaceURI() Check if this attribute has no namespace URI.
EChange	setAttributeValue(String sAttributeValue) Set the value of the attribute.

Method Detail

getNamespaceURI

@Nullable
String getNamespaceURI()

Get the namespace URI of this attribute

Returns:

May be null if this attribute has no namespace URI.

hasNamespaceURI

boolean hasNamespaceURI()

Check if this attribute has a specified namespace URI.

Returns:

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

hasNoNamespaceURI

boolean hasNoNamespaceURI()

Check if this attribute has no namespace URI.

Returns:

true if this attribute has no namespace URI, false otherwise

hasNamespaceURI

boolean hasNamespaceURI(@Nullable
                        String sNamespaceURI)

Check if this attribute has the specified namespace URI.

Parameters:

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

Returns:

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

getAttributeName

@Nonnull
String getAttributeName()

Get the name of the attribute. It never contains XML schema prefixes or the like.

Returns:

The name of the attribute and never null.

getAttributeQName

@Nonnull
IMicroQName getAttributeQName()

Get the qualified name of the attribute. It never contains XML schema prefixes or the like.

Returns:

The qualified name (namespace URI + local name) of the attribute and never null.

getAsXMLQName

@Nonnull
QName getAsXMLQName()

Returns:

The regular XML QName of this attribute using an empty prefix.

getAsXMLQName

@Nonnull
QName getAsXMLQName(@Nonnull
                              String sPrefix)

Parameters:

sPrefix - the namespace prefix to be used in the resulting object. May not be null but maybe empty.

Returns:

The regular XML QName of this attribute using the provided prefix.

getAttributeValue

@Nonnull
String getAttributeValue()

Returns:

The value associated with this attribute. Never null.

setAttributeValue

@Nonnull
EChange setAttributeValue(@Nonnull
                                    String sAttributeValue)

Set the value of the attribute.

Parameters:

sAttributeValue - The new value to be set. May not be null.

Returns:

EChange.

getClone

@Nonnull
IMicroAttribute getClone()

Specified by:

getClone in interface ICloneable<IMicroAttribute>

Returns:

A 100% deep-copy of the implementing class.