APIdia Launch Partner
Top Description Fields Methods
javax.naming

public Interface Name

extends Cloneable, Serializable, Comparable<Object>
Known Direct Implementers
javax.naming.ldap.LdapName, com.sun.jndi.ldap.LdapName, javax.naming.CompositeName, javax.naming.CompoundName
Imports
java.util.Enumeration
The Name interface represents a generic name -- an ordered sequence of components. It can be a composite name (names that span multiple namespaces), or a compound name (names that are used within individual hierarchical naming systems).

There can be different implementations of Name; for example, composite names, URLs, or namespace-specific compound names.

The components of a name are numbered. The indexes of a name with N components range from 0 up to, but not including, N. This range may be written as [0,N). The most significant component is at index 0. An empty name has no components.

None of the methods in this interface accept null as a valid value for a parameter that is a name or a name component. Likewise, methods that return a name or name component never return null.

An instance of a Name may not be synchronized against concurrent multithreaded access if that access is not read-only.

Authors
Rosanna Lee, Scott Seligman, R. Vasudevan
Since
1.3

Field Summary

Modifier and TypeField and Description
public static final long
serialVersionUID

Deprecated A serialVersionUID field in an interface is ineffectual. Do not use; no replacement.
The class fingerprint that is set to indicate serialization compatibility with a previous version of the class.

Method Summary

Modifier and TypeMethod and Description
public Name

Returns:

the updated name (not a new one)
add(String
the component to add
comp)

Adds a single component to the end of this name.

public Name

Returns:

the updated name (not a new one)
add(int
the index at which to add the new component. Must be in the range [0,size()].
posn, String
the component to add
comp)

Adds a single component at a specified position within this name.

public Name

Returns:

the updated name (not a new one)
addAll(Name
the components to add
suffix)

Adds the components of a name -- in order -- to the end of this name.

public Name

Returns:

the updated name (not a new one)
addAll(int
the index in this name at which to add the new components. Must be in the range [0,size()].
posn, Name
the components to add
n)

Adds the components of a name -- in order -- at a specified position within this name.

public Object

Returns:

a copy of this name
clone()

Generates a new copy of this name.

public int

Returns:

a negative integer, zero, or a positive integer as this name is less than, equal to, or greater than the given name
compareTo(Object
the non-null object to compare against.
obj)

Redeclares java.lang.Comparable.compareTo.

Compares this name with another name for order.

public boolean

Returns:

true if n is a suffix of this name, false otherwise
endsWith(Name
the name to check
n)

Determines whether this name ends with a specified suffix.

public String

Returns:

the component at index posn
get(int
the 0-based index of the component to retrieve. Must be in the range [0,size()).
posn)

Retrieves a component of this name.

public Enumeration<String>

Returns:

an enumeration of the components of this name, each a string
getAll()

Retrieves the components of this name as an enumeration of strings.

public Name

Returns:

a name consisting of the components at indexes in the range [0,posn).
getPrefix(int
the 0-based index of the component at which to stop. Must be in the range [0,size()].
posn)

Creates a name whose components consist of a prefix of the components of this name.

public Name

Returns:

a name consisting of the components at indexes in the range [posn,size()). If posn is equal to size(), an empty name is returned.
getSuffix(int
the 0-based index of the component at which to start. Must be in the range [0,size()].
posn)

Creates a name whose components consist of a suffix of the components in this name.

public boolean

Returns:

true if this name is empty, false otherwise
isEmpty()

Determines whether this name is empty.

public Object

Returns:

the component removed (a String)
remove(int
the index of the component to remove. Must be in the range [0,size()).
posn)

Removes a component from this name.

public int

Returns:

the number of components in this name
size()

Returns the number of components in this name.

public boolean

Returns:

true if n is a prefix of this name, false otherwise
startsWith(Name
the name to check
n)

Determines whether this name starts with a specified prefix.

Field Detail

serialVersionUIDback to summary
public static final long serialVersionUID

Deprecated

A serialVersionUID field in an interface is ineffectual. Do not use; no replacement.

The class fingerprint that is set to indicate serialization compatibility with a previous version of the class.

Annotations
@Deprecated

Method Detail

addback to summary
public Name add(String comp) throws InvalidNameException

Adds a single component to the end of this name.

Parameters
comp:String

the component to add

Returns:Name

the updated name (not a new one)

Exceptions
InvalidNameException:
if adding comp would violate the syntax rules of this name
addback to summary
public Name add(int posn, String comp) throws InvalidNameException

Adds a single component at a specified position within this name. Components of this name at or after the index of the new component are shifted up by one (away from index 0) to accommodate the new component.

Parameters
posn:int

the index at which to add the new component. Must be in the range [0,size()].

comp:String

the component to add

Returns:Name

the updated name (not a new one)

Exceptions
InvalidNameException:
if adding comp would violate the syntax rules of this name
ArrayIndexOutOfBoundsException:
if posn is outside the specified range
addAllback to summary
public Name addAll(Name suffix) throws InvalidNameException

Adds the components of a name -- in order -- to the end of this name.

Parameters
suffix:Name

the components to add

Returns:Name

the updated name (not a new one)

Exceptions
InvalidNameException:
if suffix is not a valid name, or if the addition of the components would violate the syntax rules of this name
addAllback to summary
public Name addAll(int posn, Name n) throws InvalidNameException

Adds the components of a name -- in order -- at a specified position within this name. Components of this name at or after the index of the first new component are shifted up (away from 0) to accommodate the new components.

Parameters
posn:int

the index in this name at which to add the new components. Must be in the range [0,size()].

n:Name

the components to add

Returns:Name

the updated name (not a new one)

Exceptions
InvalidNameException:
if n is not a valid name, or if the addition of the components would violate the syntax rules of this name
ArrayIndexOutOfBoundsException:
if posn is outside the specified range
cloneback to summary
public Object clone()

Generates a new copy of this name. Subsequent changes to the components of this name will not affect the new copy, and vice versa.

Returns:Object

a copy of this name

See Also
Object#clone()
compareToback to summary
public int compareTo(Object obj)

Redeclares java.lang.Comparable.compareTo.

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

As with Object.equals(), the notion of ordering for names depends on the class that implements this interface. For example, the ordering may be based on lexicographical ordering of the name components. Specific attributes of the name, such as how it treats case, may affect the ordering. In general, two names of different classes may not be compared.

Parameters
obj:Object

the non-null object to compare against.

Returns:int

a negative integer, zero, or a positive integer as this name is less than, equal to, or greater than the given name

Exceptions
ClassCastException:
if obj is not a Name of a type that may be compared with this name
See Also
Comparable#compareTo(Object)
endsWithback to summary
public boolean endsWith(Name n)

Determines whether this name ends with a specified suffix. A name n is a suffix if it is equal to getSuffix(size()-n.size()).

Parameters
n:Name

the name to check

Returns:boolean

true if n is a suffix of this name, false otherwise

getback to summary
public String get(int posn)

Retrieves a component of this name.

Parameters
posn:int

the 0-based index of the component to retrieve. Must be in the range [0,size()).

Returns:String

the component at index posn

Exceptions
ArrayIndexOutOfBoundsException:
if posn is outside the specified range
getAllback to summary
public Enumeration<String> getAll()

Retrieves the components of this name as an enumeration of strings. The effect on the enumeration of updates to this name is undefined. If the name has zero components, an empty (non-null) enumeration is returned.

Returns:Enumeration<String>

an enumeration of the components of this name, each a string

getPrefixback to summary
public Name getPrefix(int posn)

Creates a name whose components consist of a prefix of the components of this name. Subsequent changes to this name will not affect the name that is returned and vice versa.

Parameters
posn:int

the 0-based index of the component at which to stop. Must be in the range [0,size()].

Returns:Name

a name consisting of the components at indexes in the range [0,posn).

Exceptions
ArrayIndexOutOfBoundsException:
if posn is outside the specified range
getSuffixback to summary
public Name getSuffix(int posn)

Creates a name whose components consist of a suffix of the components in this name. Subsequent changes to this name do not affect the name that is returned and vice versa.

Parameters
posn:int

the 0-based index of the component at which to start. Must be in the range [0,size()].

Returns:Name

a name consisting of the components at indexes in the range [posn,size()). If posn is equal to size(), an empty name is returned.

Exceptions
ArrayIndexOutOfBoundsException:
if posn is outside the specified range
isEmptyback to summary
public boolean isEmpty()

Determines whether this name is empty. An empty name is one with zero components.

Returns:boolean

true if this name is empty, false otherwise

removeback to summary
public Object remove(int posn) throws InvalidNameException

Removes a component from this name. The component of this name at the specified position is removed. Components with indexes greater than this position are shifted down (toward index 0) by one.

Parameters
posn:int

the index of the component to remove. Must be in the range [0,size()).

Returns:Object

the component removed (a String)

Exceptions
InvalidNameException:
if deleting the component would violate the syntax rules of the name
ArrayIndexOutOfBoundsException:
if posn is outside the specified range
sizeback to summary
public int size()

Returns the number of components in this name.

Returns:int

the number of components in this name

startsWithback to summary
public boolean startsWith(Name n)

Determines whether this name starts with a specified prefix. A name n is a prefix if it is equal to getPrefix(n.size()).

Parameters
n:Name

the name to check

Returns:boolean

true if n is a prefix of this name, false otherwise