javax.naming

Interface Name

public interface Name extends Cloneable, Serializable, Comparable<Object>

Interface descriping a name build up from different components. The components are represented as Strings which are ordered from most significant to least significant. There are methods to get the number of components. Methods to get a particular component or group of components. Components can be added as Strings or Names and a component can be removed from any position in the Name. A Name can be compared to another Name and it can be checked if a particular Name starts or ends with the same components as another Name. Finally Names can be serialized and cloned.

Since Names can be empty (have no components) methods that return a Name will never return null.

Since: 1.3

Field Summary
long	serialVersionUID

Method Summary
Name	add(String comp) Adds the given `String` component to the end of this `Name`.
Name	add(int posn, String comp) Inserts the given `String` component to this `Name` at the given index.
Name	addAll(Name suffix) Adds all the components of the given `Name` to the end of this `Name`.
Name	addAll(int posn, Name n) Inserts all the components of the given `Name` to this `Name` at the given index.
Object	clone() Returns a clone of this `Name`.
int	compareTo(Object obj) Compares the given object to this `Name`.
boolean	endsWith(Name name) Returns `true` if this `Name` ends with the components of the given `Name`, `false` otherwise.
String	get(int i) Gets the component at the given index.
Enumeration<String>	getAll() Returns a non-null (but possibly empty) `Enumeration` of the components of the `Name` as `String`s.
Name	getPrefix(int posn) Returns the components till the given index as a `Name`.
Name	getSuffix(int posn) Returns the components from the given index till the end as a `Name`.
boolean	isEmpty() Returns `true` if the number of components of this `Name` is zero, `false` otherwise.
Object	remove(int posn) Removes the component at the given index from this `Name`.
int	size() Returns the number of components of this `Name`.
boolean	startsWith(Name name) Returns `true` if this `Name` starts with the components of the given `Name`, `false` otherwise.

Field Detail

serialVersionUID

public long serialVersionUID

Method Detail

add

public Name add(String comp)

Adds the given String component to the end of this Name. The method modifies the current Name and then returns it.

Throws: InvalidNameException if the given String is not a valid component for this Name.

add

public Name add(int posn, String comp)

Inserts the given String component to this Name at the given index. The method modifies the current Name and then returns it.

Throws: ArrayIndexOutOfBoundsException if the given index is smaller then zero or greater then or equal to size(). InvalidNameException if the given String is not a valid component for this Name.

addAll

public Name addAll(Name suffix)

Adds all the components of the given Name to the end of this Name. The method modifies the current Name and then returns it.

Throws: InvalidNameException if any of the given components is not a valid component for this Name.

addAll

public Name addAll(int posn, Name n)

Inserts all the components of the given Name to this Name at the given index. Components after this index (if any) are shifted up. The method modifies the current Name and then returns it.

Throws: ArrayIndexOutOfBoundsException if the given index is smaller then zero or greater then or equal to size(). InvalidNameException if any of the given components is not a valid component for this Name.

clone

public Object clone()

Returns a clone of this Name. It will be a deep copy of all the components of the Name so that changes to components of the components does not change the component in this Name.

compareTo

public int compareTo(Object obj)

Compares the given object to this Name. Returns a negative value if the given Object is smaller then this Name, a positive value if the Object is bigger, and zero if the are equal. If the Object is not of a class that can be compared to the class of this Name then a ClassCastException is thrown. Note that it is not guaranteed that Names implemented in different classes can be compared. The definition of smaller, bigger and equal is up to the actual implementing class.

endsWith

public boolean endsWith(Name name)

Returns true if this Name ends with the components of the given Name, false otherwise.

get

public String get(int i)

Gets the component at the given index.

Throws: ArrayIndexOutOfBoundsException if the given index is smaller then zero or greater then or equal to size().

getAll

public Enumeration<String> getAll()

Returns a non-null (but possibly empty) Enumeration of the components of the Name as Strings.

getPrefix

public Name getPrefix(int posn)

Returns the components till the given index as a Name. The returned Name can be modified without changing the original.

Parameters: posn the ending position, exclusive

Throws: ArrayIndexOutOfBoundsException if the given index is smaller then zero or greater then or equal to size().

getSuffix

public Name getSuffix(int posn)

Returns the components from the given index till the end as a Name. The returned Name can be modified without changing the original.

Parameters: posn the starting position, inclusive. If it is equal to the size of the name, the empty name is returned.

Throws: ArrayIndexOutOfBoundsException if the given index is smaller then zero or greater then or equal to size().

isEmpty

public boolean isEmpty()

Returns true if the number of components of this Name is zero, false otherwise.

remove

public Object remove(int posn)

Removes the component at the given index from this Name. The method modifies the current Name and then returns it.

Throws: InvalidNameException if the given String is not a valid component for this Name.

size

public int size()

Returns the number of components of this Name. The returned number can be zero.

startsWith

public boolean startsWith(Name name)

Returns true if this Name starts with the components of the given Name, false otherwise.