Class AttributeList
- java.lang.Object
-
- org.pentaho.reporting.libraries.xmlns.common.AttributeList
-
public class AttributeList extends Object
The attribute list is used by a writer to specify the attributes of an XML element in a certain order.- Author:
- Thomas Morgner
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AttributeList.AttributeEntry
A name/value pair of the attribute list.
-
Field Summary
Fields Modifier and Type Field Description static String
XML_NAMESPACE
A constant containing the XML namespace identifier.static String
XMLNS_NAMESPACE
A constant containing the XML-Namespace namespace identifier.
-
Constructor Summary
Constructors Constructor Description AttributeList()
Creates an empty attribute list with no default values.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addNamespaceDeclaration(String prefix, String namespaceUri)
Adds a namespace declaration.String
getAttribute(String namespace, String name)
Returns the attribute value for the given attribute name or null, if the attribute is not defined in this list.String
getAttribute(String namespace, String name, String defaultValue)
Returns the attribute value for the given attribute name or the given defaultvalue, if the attribute is not defined in this list.boolean
isEmpty()
Checks, whether this list is empty.boolean
isNamespacePrefixDefined(String prefix)
Checks, whether the given prefix is defined.boolean
isNamespaceUriDefined(String uri)
Checks, whether the given namespace URI has a defined prefix.Iterator
iterator()
Deprecated.use toArray instead.void
removeAttribute(String namespace, String name)
Removes the attribute with the given name from the list.void
removeNamespaceDeclaration(String prefix)
Removes a namespace declaration from this attribute list.void
setAttribute(String namespace, String name, String value)
Defines an attribute.AttributeList.AttributeEntry[]
toArray()
-
-
-
Field Detail
-
XMLNS_NAMESPACE
public static final String XMLNS_NAMESPACE
A constant containing the XML-Namespace namespace identifier.- See Also:
- Constant Field Values
-
XML_NAMESPACE
public static final String XML_NAMESPACE
A constant containing the XML namespace identifier.- See Also:
- Constant Field Values
-
-
Method Detail
-
iterator
public Iterator iterator()
Deprecated.use toArray instead.Returns an iterator over the entry list. The iterator returns AttributeList.AttributeEntry objects.- Returns:
- the iterator over the entries contained in this list.
-
toArray
public AttributeList.AttributeEntry[] toArray()
-
setAttribute
public void setAttribute(String namespace, String name, String value)
Defines an attribute.- Parameters:
namespace
- the namespace of the attribute.name
- the name of the attribute to be definedvalue
- the value of the attribute.
-
getAttribute
public String getAttribute(String namespace, String name)
Returns the attribute value for the given attribute name or null, if the attribute is not defined in this list.- Parameters:
namespace
- the namespace of the attribute.name
- the name of the attribute- Returns:
- the attribute value or null.
-
getAttribute
public String getAttribute(String namespace, String name, String defaultValue)
Returns the attribute value for the given attribute name or the given defaultvalue, if the attribute is not defined in this list.- Parameters:
namespace
- the namespace of the attribute.name
- the name of the attribute.defaultValue
- the default value.- Returns:
- the attribute value or the defaultValue.
-
removeAttribute
public void removeAttribute(String namespace, String name)
Removes the attribute with the given name from the list.- Parameters:
namespace
- the namespace of the attribute that should be removed.name
- the name of the attribute which should be removed..
-
isEmpty
public boolean isEmpty()
Checks, whether this list is empty.- Returns:
- true, if the list is empty, false otherwise.
-
addNamespaceDeclaration
public void addNamespaceDeclaration(String prefix, String namespaceUri)
Adds a namespace declaration. In XML, Namespaces are declared by using a special attribute-syntax. As this syntax is confusing and complicated, this method encapsulates this and make defining namespaces less confusing.- Parameters:
prefix
- the desired namespace prefix (can be null or empty to define the default namespace.namespaceUri
- the URI of the namespace.
-
removeNamespaceDeclaration
public void removeNamespaceDeclaration(String prefix)
Removes a namespace declaration from this attribute list.- Parameters:
prefix
- the declared namespace prefix.
-
isNamespacePrefixDefined
public boolean isNamespacePrefixDefined(String prefix)
Checks, whether the given prefix is defined.- Parameters:
prefix
- the namespace prefix.- Returns:
- true, if the prefix is defined, false otherwise.
-
isNamespaceUriDefined
public boolean isNamespaceUriDefined(String uri)
Checks, whether the given namespace URI has a defined prefix.- Parameters:
uri
- the uri.- Returns:
- true, if there is at least one namespace declaration matching the given URI, false otherwise.
-
-