com.tangosol.run.xml

Class QualifiedName

java.lang.Object

com.tangosol.run.xml.QualifiedName

public class QualifiedName
extends Object

A QualifiedName is a useful class to separately capture the xml namespace prefix and local name of xml elements and attributes as a single object (instead of having to parse them out of Strings all the time). For example, the xmlName "movie:definition" has the namespace prefix "movie" and the local name "definition". If there is no namespace prefix declared, the prefix is always returned as "".

Author:

bko 2011.06.22

Constructor Summary

Constructors

Constructor and Description
QualifiedName(QualifiedName qualifiedName, String localName) Standard Constructor (using a specified QualifiedName for the prefix).
QualifiedName(String xmlName) Standard Constructor.
QualifiedName(String prefix, String localName) Standard Constructor.
QualifiedName(XmlElement xmlElement) Standard Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
String	getLocalName() Returns the local name of the QualifiedName.
String	getName() Returns the entire qualified name, including the prefix and local name.
String	getPrefix() Returns the xml prefix of the QualifiedName.
int	hashCode()
boolean	hasPrefix() Returns boolean based on if the QualifiedName has a namespace prefix.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

QualifiedName

public QualifiedName(String xmlName)
              throws UnknownFormatConversionException

Standard Constructor.

Parameters:

xmlName - The name of an xml element/attribute from which to create a qualified name. Must be of the format "prefix:name" or simply "name" (in which case the prefix is considered "")

Throws:

UnknownFormatConversionException - When the specified xmlName is invalid (contains mulitple :'s)

QualifiedName

public QualifiedName(XmlElement xmlElement)
              throws UnknownFormatConversionException

Standard Constructor.

Parameters:

xmlElement - An XmlElement from which to return the QualifiedName

Throws:

UnknownFormatConversionException - When the specified xmlElement is invalid (contains mulitple :'s)

QualifiedName

public QualifiedName(QualifiedName qualifiedName,
                     String localName)

Standard Constructor (using a specified QualifiedName for the prefix).

Parameters:

qualifiedName - The QualifiedName on which to base the new QualifiedName.

localName - The local name for the new QualifiedName.

QualifiedName

public QualifiedName(String prefix,
                     String localName)

Standard Constructor.

Parameters:

prefix - The xmlns prefix for the QualifiedName

localName - The localname for the QualifiedName

Method Detail

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getPrefix

public String getPrefix()

Returns the xml prefix of the QualifiedName.

Returns:

Returns "" if the name is not qualified with a namespace prefix

getLocalName

public String getLocalName()

Returns the local name of the QualifiedName.

Returns:

Returns the local part of a qualified name.

getName

public String getName()

Returns the entire qualified name, including the prefix and local name.

Returns:

A string containing the entire qualified name, including prefix and local name.

hasPrefix

public boolean hasPrefix()

Returns boolean based on if the QualifiedName has a namespace prefix.

Returns:

true If the QualifiedName has an xmlns prefix