|
JNDI 1.2 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
Fields inherited from class java.io.Serializable |
serialVersionUID |
Method Summary | |
Name |
add(int posn,
String comp)
Adds a single component at a specified position within this name. |
Name |
add(String comp)
Adds a single component to the end of this name. |
Name |
addAll(int posn,
Name n)
Adds the components of a name -- in order -- at a specified position within this name. |
Name |
addAll(Name suffix)
Adds the components of a name -- in order -- to the end of this name. |
Object |
clone()
Generates a new copy of this name. |
int |
compareTo(Object obj)
Compares this name with another name for order. |
boolean |
endsWith(Name n)
Determines whether this name ends with a specified suffix. |
String |
get(int posn)
Retrieves a component of this name. |
Enumeration |
getAll()
Retrieves the components of this name as an enumeration of strings. |
Name |
getPrefix(int posn)
Creates a name whose components consist of a prefix of the components of this name. |
Name |
getSuffix(int posn)
Creates a name whose components consist of a suffix of the components in this name. |
boolean |
isEmpty()
Determines whether this name is empty. |
Object |
remove(int posn)
Removes a component from this name. |
int |
size()
Returns the number of components in this name. |
boolean |
startsWith(Name n)
Determines whether this name starts with a specified prefix. |
Method Detail |
public Object clone()
Object.clone()
public int compareTo(Object obj)
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.
Comparable.compareTo(Object)
public int size()
public boolean isEmpty()
public Enumeration getAll()
public String get(int posn)
posn
- the 0-based index of the component to retrieve.
Must be in the range [0,size()).public Name getPrefix(int posn)
posn
- the 0-based index of the component at which to stop.
Must be in the range [0,size()].public Name getSuffix(int posn)
posn
- the 0-based index of the component at which to start.
Must be in the range [0,size()].public boolean startsWith(Name n)
n
- the name to checkpublic boolean endsWith(Name n)
n
- the name to checkpublic Name addAll(Name suffix) throws InvalidNameException
suffix
- the components to addpublic Name addAll(int posn, Name n) throws InvalidNameException
n
- the components to addposn
- the index in this name at which to add the new
components. Must be in the range [0,size()].public Name add(String comp) throws InvalidNameException
comp
- the component to addpublic Name add(int posn, String comp) throws InvalidNameException
comp
- the component to addposn
- the index at which to add the new component.
Must be in the range [0,size()].public Object remove(int posn) throws InvalidNameException
posn
- the index of the component to remove.
Must be in the range [0,size()).
|
JNDI 1.2 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |