APIdia Launch Partner
Top Description Fields Constructors Methods
javax.naming

public Class CompositeName

extends Object
implements Name
Class Inheritance
All Implemented Interfaces
javax.naming.Name, java.lang.Comparable, java.io.Serializable, java.lang.Cloneable
Imports
java.util.Enumeration, .Properties
This class represents a composite name -- a sequence of component names spanning multiple namespaces. Each component is a string name from the namespace of a naming system. If the component comes from a hierarchical namespace, that component can be further parsed into its atomic parts by using the CompoundName class.

The components of a composite name are numbered. The indexes of a composite 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 composite name has no components.

JNDI Composite Name Syntax

JNDI defines a standard string representation for composite names. This representation is the concatenation of the components of a composite name from left to right using the component separator (a forward slash character (/)) to separate each component. The JNDI syntax defines the following meta characters: Any occurrence of a leading quote, an escape preceding any meta character, an escape at the end of a component, or a component separator character in an unquoted component must be preceded by an escape character when that component is being composed into a composite name string. Alternatively, to avoid adding escape characters as described, the entire component can be quoted using matching single quotes or matching double quotes. A single quote occurring within a double-quoted component is not considered a meta character (and need not be escaped), and vice versa.

When two composite names are compared, the case of the characters is significant.

A leading component separator (the composite name string begins with a separator) denotes a leading empty component (a component consisting of an empty string). A trailing component separator (the composite name string ends with a separator) denotes a trailing empty component. Adjacent component separators denote an empty component.

Composite Name Examples

This table shows examples of some composite names. Each row shows the string form of a composite name and its corresponding structural form (CompositeName).
examples showing string form of composite name and its corresponding structural form (CompositeName)
String Name CompositeName
"" {} (the empty name == new CompositeName("") == new CompositeName())
"x" {"x"}
"x/y" {"x", "y"}
"x/" {"x", ""}
"/x" {"", "x"}
"/" {""}
"//" {"", ""}
"/x/" {"", "x", ""}
"x//y" {"x", "", "y"}

Composition Examples

Here are some composition examples. The right column shows composing string composite names while the left column shows composing the corresponding CompositeNames. Notice that composing the string forms of two composite names simply involves concatenating their string forms together.
composition examples showing string names and composite names
String Names CompositeNames
"x/y" + "/" = x/y/ {"x", "y"} + {""} = {"x", "y", ""}
"" + "x" = "x" {} + {"x"} = {"x"}
"/" + "x" = "/x" {""} + {"x"} = {"", "x"}
"x" + "" + "" = "x" {"x"} + {} + {} = {"x"}

Multithreaded Access

A CompositeName instance is not synchronized against concurrent multithreaded access. Multiple threads trying to access and modify a CompositeName should lock the object.
Authors
Rosanna Lee, Scott Seligman
Since
1.3

Field Summary

Modifier and TypeField and Description
private transient NameImpl
impl

private static final long
serialVersionUID

Hides javax.naming.Name.serialVersionUID.

Use serialVersionUID from JNDI 1.1.1 for interoperability

Constructor Summary

AccessConstructor and Description
protected
CompositeName(Enumeration<String>
A non-null enumeration containing the components for the new composite name. Each element is of class String. The enumeration will be consumed to extract its elements.
comps)

Constructs a new composite name instance using the components specified by 'comps'.

public
CompositeName(String
The non-null string to parse.
n)

Constructs a new composite name instance by parsing the string n using the composite name syntax (left-to-right, slash separated).

public
CompositeName()

Constructs a new empty composite name.

Method Summary

Modifier and TypeMethod and Description
public Name

Returns:

The updated CompositeName, not a new one. Cannot be null.
add(String
The non-null component to add.
comp)

Implements javax.naming.Name.add.

Adds a single component to the end of this composite name.

public Name

Returns:

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

Implements javax.naming.Name.add.

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

public Name

Returns:

The updated CompositeName, not a new one. Cannot be null.
addAll(Name
The non-null components to add.
suffix)

Implements javax.naming.Name.addAll.

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

public Name

Returns:

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

Implements javax.naming.Name.addAll.

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

public Object

Returns:

A non-null copy of this composite name.
clone()

Overrides java.lang.Object.clone.

Implements javax.naming.Name.clone.

Generates a copy of this composite 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 Object.
compareTo(Object
The non-null object to compare against.
obj)

Implements javax.naming.Name.compareTo.

Compares this CompositeName with the specified Object for order.

public boolean

Returns:

true if n is a CompositeName and is a suffix of this composite name, false otherwise.
endsWith(Name
The possibly null name to check.
n)

Implements javax.naming.Name.endsWith.

Determines whether a composite name is a suffix of this composite name.

public boolean

Returns:

true if obj is equal to this composite name, false otherwise.
equals(Object
The possibly null object to compare against.
obj)

Overrides java.lang.Object.equals.

Determines whether two composite names are equal.

public String

Returns:

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

Implements javax.naming.Name.get.

Retrieves a component of this composite name.

public Enumeration<String>

Returns:

A non-null enumeration of the components of this composite name. Each element of the enumeration is of class String.
getAll()

Implements javax.naming.Name.getAll.

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

public Name

Returns:

A composite 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)

Implements javax.naming.Name.getPrefix.

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

public Name

Returns:

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

Implements javax.naming.Name.getSuffix.

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

public int

Returns:

An int representing the hash code of this name.
hashCode()

Overrides java.lang.Object.hashCode.

Computes the hash code of this composite name.

public boolean

Returns:

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

Implements javax.naming.Name.isEmpty.

Determines whether this composite name is empty.

private void
readObject(ObjectInputStream
the ObjectInputStream to read from
s)

The readObject method is called to restore the state of the CompositeName from a stream.

public Object

Returns:

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

Implements javax.naming.Name.remove.

Deletes a component from this composite name.

public int

Returns:

The nonnegative number of components in this composite name.
size()

Implements javax.naming.Name.size.

Retrieves the number of components in this composite name.

public boolean

Returns:

true if n is a CompositeName and is a prefix of this composite name, false otherwise.
startsWith(Name
The possibly null name to check.
n)

Implements javax.naming.Name.startsWith.

Determines whether a composite name is a prefix of this composite name.

public String

Returns:

A non-null string representation of this composite name.
toString()

Overrides java.lang.Object.toString.

Generates the string representation of this composite name.

private void
writeObject(ObjectOutputStream
the ObjectOutputStream to write to
s)

The writeObject method is called to save the state of the CompositeName to a stream.

Inherited from java.lang.Object:
finalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

implback to summary
private transient NameImpl impl
serialVersionUIDback to summary
private static final long serialVersionUID

Hides javax.naming.Name.serialVersionUID.

Use serialVersionUID from JNDI 1.1.1 for interoperability

Annotations
@Serial

Constructor Detail

CompositeNameback to summary
protected CompositeName(Enumeration<String> comps)

Constructs a new composite name instance using the components specified by 'comps'. This protected method is intended to be used by subclasses of CompositeName when they override methods such as clone(), getPrefix(), getSuffix().

Parameters
comps:Enumeration<String>

A non-null enumeration containing the components for the new composite name. Each element is of class String. The enumeration will be consumed to extract its elements.

CompositeNameback to summary
public CompositeName(String n) throws InvalidNameException

Constructs a new composite name instance by parsing the string n using the composite name syntax (left-to-right, slash separated). The composite name syntax is described in detail in the class description.

Parameters
n:String

The non-null string to parse.

Exceptions
InvalidNameException:
If n has invalid composite name syntax.
CompositeNameback to summary
public CompositeName()

Constructs a new empty composite name. Such a name returns true when isEmpty() is invoked on it.

Method Detail

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

Implements javax.naming.Name.add.

Adds a single component to the end of this composite name.

Parameters
comp:String

The non-null component to add.

Returns:Name

The updated CompositeName, not a new one. Cannot be null.

Exceptions
InvalidNameException:
If adding comp at end of the name would violate the name's syntax.
addback to summary
public Name add(int posn, String comp) throws InvalidNameException

Implements javax.naming.Name.add.

Adds a single component at a specified position within this composite name. Components of this composite 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 non-null component to add.

Returns:Name

The updated CompositeName, not a new one. Cannot be null.

Exceptions
InvalidNameException:
If adding comp at the specified position would violate the name's syntax.
ArrayIndexOutOfBoundsException:
If posn is outside the specified range.
addAllback to summary
public Name addAll(Name suffix) throws InvalidNameException

Implements javax.naming.Name.addAll.

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

Parameters
suffix:Name

The non-null components to add.

Returns:Name

The updated CompositeName, not a new one. Cannot be null.

Exceptions
InvalidNameException:
If suffix is not a composite name.
addAllback to summary
public Name addAll(int posn, Name n) throws InvalidNameException

Implements javax.naming.Name.addAll.

Adds the components of a composite name -- in order -- at a specified position within this composite name. Components of this composite name at or after the index of the first new component are shifted up (away from index 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 non-null components to add.

Returns:Name

The updated CompositeName, not a new one. Cannot be null.

Exceptions
InvalidNameException:
If n is not a composite name.
ArrayIndexOutOfBoundsException:
If posn is outside the specified range.
cloneback to summary
public Object clone()

Overrides java.lang.Object.clone.

Implements javax.naming.Name.clone.

Generates a copy of this composite name. Changes to the components of this composite name won't affect the new copy and vice versa.

Returns:Object

A non-null copy of this composite name.

compareToback to summary
public int compareTo(Object obj)

Implements javax.naming.Name.compareTo.

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

If obj is null or not an instance of CompositeName, ClassCastException is thrown.

See equals() for what it means for two composite names to be equal. If two composite names are equal, 0 is returned.

Ordering of composite names follows the lexicographical rules for string comparison, with the extension that this applies to all the components in the composite name. The effect is as if all the components were lined up in their specified ordered and the lexicographical rules applied over the two line-ups. If this composite name is "lexicographically" lesser than obj, a negative number is returned. If this composite name is "lexicographically" greater than obj, a positive number is returned.

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 Object.

Exceptions
ClassCastException:
if obj is not a CompositeName.
endsWithback to summary
public boolean endsWith(Name n)

Implements javax.naming.Name.endsWith.

Determines whether a composite name is a suffix of this composite name. A composite name 'n' is a suffix if it is equal to getSuffix(size()-n.size())--in other words, this composite name ends with 'n'. If n is null or not a composite name, false is returned.

Parameters
n:Name

The possibly null name to check.

Returns:boolean

true if n is a CompositeName and is a suffix of this composite name, false otherwise.

equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Determines whether two composite names are equal. If obj is null or not a composite name, false is returned. Two composite names are equal if each component in one is equal to the corresponding component in the other. This implies both have the same number of components, and each component's equals() test against the corresponding component in the other name returns true.

Parameters
obj:Object

The possibly null object to compare against.

Returns:boolean

true if obj is equal to this composite name, false otherwise.

See Also
hashCode
getback to summary
public String get(int posn)

Implements javax.naming.Name.get.

Retrieves a component of this composite name.

Parameters
posn:int

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

Returns:String

The non-null component at index posn.

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

Implements javax.naming.Name.getAll.

Retrieves the components of this composite name as an enumeration of strings. The effects of updates to this composite name on this enumeration is undefined.

Returns:Enumeration<String>

A non-null enumeration of the components of this composite name. Each element of the enumeration is of class String.

getPrefixback to summary
public Name getPrefix(int posn)

Implements javax.naming.Name.getPrefix.

Creates a composite name whose components consist of a prefix of the components in this composite name. Subsequent changes to this composite name does not affect the name that is returned.

Parameters
posn:int

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

Returns:Name

A composite 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)

Implements javax.naming.Name.getSuffix.

Creates a composite name whose components consist of a suffix of the components in this composite name. Subsequent changes to this composite name does not affect the name that is returned.

Parameters
posn:int

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

Returns:Name

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

Exceptions
ArrayIndexOutOfBoundsException:
If posn is outside the specified range.
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Computes the hash code of this composite name. The hash code is the sum of the hash codes of individual components of this composite name.

Returns:int

An int representing the hash code of this name.

See Also
equals
isEmptyback to summary
public boolean isEmpty()

Implements javax.naming.Name.isEmpty.

Determines whether this composite name is empty. A composite name is empty if it has zero components.

Returns:boolean

true if this composite name is empty, false otherwise.

readObjectback to summary
private void readObject(ObjectInputStream s) throws IOException, ClassNotFoundException

The readObject method is called to restore the state of the CompositeName from a stream. See writeObject for a description of the serial form.

Parameters
s:ObjectInputStream

the ObjectInputStream to read from

Annotations
@Serial
Exceptions
IOException:
if an I/O error occurs
ClassNotFoundException:
if the class of a serialized object could not be found
removeback to summary
public Object remove(int posn) throws InvalidNameException

Implements javax.naming.Name.remove.

Deletes a component from this composite name. The component of this composite name at position 'posn' is removed, and components at indices greater than 'posn' are shifted down (towards index 0) by one.

Parameters
posn:int

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

Returns:Object

The component removed (a String).

Exceptions
InvalidNameException:
If deleting the component would violate the name's syntax.
ArrayIndexOutOfBoundsException:
If posn is outside the specified range (includes case where composite name is empty).
sizeback to summary
public int size()

Implements javax.naming.Name.size.

Retrieves the number of components in this composite name.

Returns:int

The nonnegative number of components in this composite name.

startsWithback to summary
public boolean startsWith(Name n)

Implements javax.naming.Name.startsWith.

Determines whether a composite name is a prefix of this composite name. A composite name 'n' is a prefix if it is equal to getPrefix(n.size())--in other words, this composite name starts with 'n'. If 'n' is null or not a composite name, false is returned.

Parameters
n:Name

The possibly null name to check.

Returns:boolean

true if n is a CompositeName and is a prefix of this composite name, false otherwise.

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Generates the string representation of this composite name. The string representation consists of enumerating in order each component of the composite name and separating each component by a forward slash character. Quoting and escape characters are applied where necessary according to the JNDI syntax, which is described in the class description. An empty component is represented by an empty string. The string representation thus generated can be passed to the CompositeName constructor to create a new equivalent composite name.

Returns:String

A non-null string representation of this composite name.

writeObjectback to summary
private void writeObject(ObjectOutputStream s) throws IOException

The writeObject method is called to save the state of the CompositeName to a stream.

Parameters
s:ObjectOutputStream

the ObjectOutputStream to write to

Annotations
@Serial
Exceptions
IOException:
if an I/O error occurs
Serial data
The number of components (an int) followed by the individual components (each a String).