org.da.protoframework.model.namespace

Class NamespaceKey

java.lang.Object

org.da.protoframework.model.namespace.NamespaceKey

All Implemented Interfaces:

java.lang.Comparable<NamespaceKey>

public class NamespaceKey
extends java.lang.Object
implements java.lang.Comparable<NamespaceKey>

A key which is constituted by a namespace and a name.

Constructor Summary

Constructors

Constructor and Description
NamespaceKey(java.lang.String name) Constructor with a null URI.
NamespaceKey(java.lang.String uri, java.lang.String name) Constructor.
NamespaceKey(java.net.URI uri, java.lang.String name) Constructor.

Method Summary

Modifier and Type	Method and Description
int	compareTo(NamespaceKey o)
static NamespaceKey	createKey(java.lang.String name) Create a key without a URI.
static NamespaceKey	createKey(java.lang.String uri, java.lang.String name) Create a key from an URI expressed as a String and a name.
static NamespaceKey	createKeyFromString(java.lang.String stringRep) Create a key from a String representation.
boolean	equals(java.lang.Object obj)
boolean	equals(java.lang.String uri, java.lang.String name) Return true if the key is equal to another key defined by its name and namespace.
java.lang.String	getName() Return the name
java.lang.String	getStringRepresentation() Return a String representation of the key.
java.net.URI	getURI() Return the URI
int	hashCode()
boolean	hasURI() Return true if the key has an URI.
boolean	isKey(java.lang.String name) Return true if the key is equal to another key defined by its name (with no namespace).
boolean	isKey(java.lang.String uri, java.lang.String name) Return true if the key is equal to another key defined by its name and namespace.
NamespaceKey	stripNamespace() Return a new NamespaceKey without the namespace part.
java.lang.String	toString() Return a String representation of the key.

Methods inherited from class java.lang.Object

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

Constructor Detail

NamespaceKey

public NamespaceKey(java.net.URI uri,
                    java.lang.String name)

Constructor.

Parameters:

uri - the URI

name - the name

NamespaceKey

public NamespaceKey(java.lang.String uri,
                    java.lang.String name)
             throws java.net.URISyntaxException

Constructor.

Parameters:

uri - the URI

name - the name

Throws:

java.net.URISyntaxException - if the uri is not valid

NamespaceKey

public NamespaceKey(java.lang.String name)

Constructor with a null URI.

Parameters:

name - the name

Method Detail

createKey

public static NamespaceKey createKey(java.lang.String name)

Create a key without a URI.

Parameters:

name - the name

Returns:

the key

createKeyFromString

public static NamespaceKey createKeyFromString(java.lang.String stringRep)

Create a key from a String representation. The representation will have one of the following patterns:

• <name>
• <uri>:<name>

Parameters:

stringRep - the string representation of the key

Returns:

the key

createKey

public static NamespaceKey createKey(java.lang.String uri,
                                     java.lang.String name)

Create a key from an URI expressed as a String and a name.

Parameters:

uri - the URI as a String

name - the name

Returns:

the key

isKey

public boolean isKey(java.lang.String name)

Return true if the key is equal to another key defined by its name (with no namespace).

Parameters:

name - the other key name

Returns:

true if the key is equal to the other key defined by its name and namespace

isKey

public boolean isKey(java.lang.String uri,
                     java.lang.String name)

Return true if the key is equal to another key defined by its name and namespace.

Parameters:

uri - the other key namespace

name - the other key name

Returns:

true if the key is equal to the other key defined by its name and namespace

equals

public boolean equals(java.lang.String uri,
                      java.lang.String name)

Return true if the key is equal to another key defined by its name and namespace.

Parameters:

uri - the other key namespace

name - the other key name

Returns:

true if the key is equal to the other key defined by its name and namespace

getName

public java.lang.String getName()

Return the name

Returns:

the name

getURI

public java.net.URI getURI()

Return the URI

Returns:

the URI

hasURI

public boolean hasURI()

Return true if the key has an URI.

Returns:

true if the key has an URI

stripNamespace

public NamespaceKey stripNamespace()

Return a new NamespaceKey without the namespace part.

Returns:

the new NamespaceKey

getStringRepresentation

public java.lang.String getStringRepresentation()

Return a String representation of the key. The representation will have one of the following patterns:

• <name>
• <uri>:<name>

Returns:

the String representation

toString

public java.lang.String toString()

Return a String representation of the key. Same result as getStringRepresentation().

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

compareTo

public int compareTo(NamespaceKey o)

Specified by:

compareTo in interface java.lang.Comparable<NamespaceKey>