org.kocakosm.pitaya.net

Class URN

java.lang.Object

org.kocakosm.pitaya.net.URN

All Implemented Interfaces:

Serializable

public final class URN
extends Object
implements Serializable

Represents a Uniform Resource Name (URN) as specified in RFC 2141. Instances of this class are immutable.

Author:

Osman KOCAK

See Also:

RFC 2141, Serialized Form

Constructor Summary

Constructors

Constructor and Description
URN(String urn) Creates a new URN by parsing the given String as specified by the grammar in RFC 2141.
URN(String nid, String nss) Creates a new URN with the specified Namespace Identifier and Namespace Specific String.
URN(String scheme, String nid, String nss) Creates a new URN with the specified scheme, Namespace Identifier and Namespace Specific String.

Method Summary

Methods

Modifier and Type	Method and Description
static URN	create(String urn) Creates a new URN by parsing the given String.
boolean	equals(Object o)
int	hashCode()
String	nid() Returns the Namespace Identifier part of this URN.
URN	normalized() Returns the normalized equivalent of this URN.
String	nss() Returns the Namespace Specific String of this URN.
String	scheme() Returns the scheme part of this URN, namely it returns "urn" modulo the case.
String	toString()
URI	toURI() Returns the URI equivalent to this URN.

Methods inherited from class java.lang.Object

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

Constructor Detail

URN

public URN(String urn)
    throws URNSyntaxException

Creates a new URN by parsing the given String as specified by the grammar in RFC 2141.

Parameters:

urn - the String to be parsed into a URN.

Throws:

NullPointerException - if urn is null.

URNSyntaxException - if urn violates RFC 2141.

URN

public URN(String nid,
   String nss)
    throws URNSyntaxException

Creates a new URN with the specified Namespace Identifier and Namespace Specific String.

Parameters:

nid - the Namespace Identifier.

nss - the Namespace Specific String.

Throws:

NullPointerException - if one of the arguments is null.

URNSyntaxException - if the URN constructed from the given components violates RFC 2141.

URN

public URN(String scheme,
   String nid,
   String nss)
    throws URNSyntaxException

Creates a new URN with the specified scheme, Namespace Identifier and Namespace Specific String.

Parameters:

scheme - the scheme, must be equal to "urn", ignoring the case.

nid - the Namespace Identifier.

nss - the Namespace Specific String.

Throws:

NullPointerException - if one of the arguments is null.

URNSyntaxException - if the URN constructed from the given components violates RFC 2141.

Method Detail

create

public static URN create(String urn)

Creates a new URN by parsing the given String. This function invokes the URN(java.lang.String) constructor; any URNSyntaxException thrown by the constructor is caught and wrapped in a new IllegalArgumentException, which is then thrown. This method is provided for use in situations where it is known that the given String is a legal URN.

Parameters:

urn - the String to be parsed into a URN.

Returns:

the created URN.

Throws:

NullPointerException - if urn is null.

IllegalArgumentException - if urn violates RFC 2141.

scheme

public String scheme()

Returns the scheme part of this URN, namely it returns "urn" modulo the case.

Returns:

this URN's scheme.

nid

public String nid()

Returns the Namespace Identifier part of this URN.

Returns:

this URN's NID.

nss

public String nss()

Returns the Namespace Specific String of this URN.

Returns:

this URN's NSS.

normalized

public URN normalized()

Returns the normalized equivalent of this URN. Normalizing a URN consists in lower-casing its scheme, NID and percent encoded parts.

Returns:

the normalized equivalent of this URN.

toURI

public URI toURI()

Returns the URI equivalent to this URN.

Returns:

the URI equivalent to this URN.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object