org.jdiameter.api

Class URI

java.lang.Object

org.jdiameter.api.URI

All Implemented Interfaces:

Serializable, Comparable

public final class URI
extends Object
implements Comparable, Serializable

This class handles Diameter URIs. It only implements parts that are needed for the Diameter URI

Version:

1.5.1 Final

Author:

erick.svenson@yahoo.com, Alexandre Mendonca , Bartosz Baranowski , Yulian Oifa

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
URI(String uri) Constructor with string parameter

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Object obj) Compares this object with the specified object for order.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
String	getFQDN()
String	getPath()
int	getPort() Returns the port number of this URI, or -1 if this is not set.
String	getProtocolParam()
String	getScheme()
String	getTransportParam()
int	hashCode() Returns a hash code value for the object.
boolean	isSecure()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

URI

public URI(String uri)
    throws URISyntaxException,
           UnknownServiceException

Constructor with string parameter

Parameters:

uri - String representation of URI

Throws:

URISyntaxException - which signals that URI has syntax error

UnknownServiceException - which signals that URI has incorrect scheme

Method Detail

getScheme

public String getScheme()

Returns:

scheme for URI

getFQDN

public String getFQDN()

Returns:

host name of URI

getPort

public int getPort()

Returns the port number of this URI, or -1 if this is not set.

Returns:

the port number of this URI

isSecure

public boolean isSecure()

Returns:

true if this URI is secure

getPath

public String getPath()

Returns:

path of this URI

getProtocolParam

public String getProtocolParam()

Returns:

protocol parameter of this URI

getTransportParam

public String getTransportParam()

Returns:

transport parameter of this URI

toString

public String toString()

Overrides:

toString in class Object

Returns:

String representation of this URI in RFC 3588 format

equals

public boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Overrides:

equals in class Object

Parameters:

obj - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

See Also:

hashCode(), Hashtable

hashCode

public int hashCode()

Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hashtables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java^TM programming language.)

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

See Also:

Object.equals(java.lang.Object), Hashtable

compareTo

public int compareTo(Object obj)

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

In the foregoing description, the notation sgn(expression) designates the mathematical signum function, which is defined to return one of -1, 0, or 1 according to whether the value of expression is negative, zero or positive. The implementor must ensure sgn(x.compareTo(y)) == -sgn(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception iff y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y)>0 && y.compareTo(z)>0) implies x.compareTo(z)>0.

Finally, the implementer must ensure that x.compareTo(y)==0 implies that sgn(x.compareTo(z)) == sgn(y.compareTo(z)), for all z.

It is strongly recommended, but not strictly required that (x.compareTo(y)==0) == (x.equals(y)). Generally speaking, any class that implements the Comparable interface and violates this condition should clearly indicate this fact. The recommended language is "Note: this class has a natural ordering that is inconsistent with equals."

Specified by:

compareTo in interface Comparable

Parameters:

obj - the Object to be compared.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Throws:

ClassCastException - if the specified object's type prevents it from being compared to this Object.