public class CompositeName extends Object implements Name
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.
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.
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"} |
CompositeNames. Notice that composing the string forms of two composite names simply involves concatenating their string forms together. | String Names | CompositeNames |
|---|---|
| "x/y" + "/" = x/y/ | {"x", "y"} + {""} = {"x", "y", ""} |
| "" + "x" = "x" | {} + {"x"} = {"x"} |
| "/" + "x" = "/x" | {""} + {"x"} = {"", "x"} |
| "x" + "" + "" = "x" | {"x"} + {} + {} = {"x"} |
CompositeName instance is not synchronized against concurrent multithreaded access. Multiple threads trying to access and modify a CompositeName should lock the object.protected CompositeName(Enumeration<String> comps)
Constructs a new composite name instance using the components specified by 'comps'. This protected method is intended to be to be used by subclasses of CompositeName when they override methods such as clone(), getPrefix(), getSuffix().
comps - 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.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.
n - The non-null string to parse.InvalidNameException - If n has invalid composite name syntax.public CompositeName()
Constructs a new empty composite name. Such a name returns true when isEmpty() is invoked on it.
public String 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.
toString in class Object
public boolean equals(Object obj)
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.
equals in class Object
obj - The possibly null object to compare against.hashCode()public int 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.
hashCode in class Object
equals(java.lang.Object)public int compareTo(Object obj)
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.
compareTo in interface Comparable<Object>
compareTo in interface Name
obj - The non-null object to compare against.ClassCastException - if obj is not a CompositeName.Comparable.compareTo(Object)public Object 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.
clone in interface Name
clone in class Object
Cloneablepublic int size()
Retrieves the number of components in this composite name.
size in interface Name
public boolean isEmpty()
Determines whether this composite name is empty. A composite name is empty if it has zero components.
isEmpty in interface Name
public Enumeration<String> 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.
getAll in interface Name
public String get(int posn)
Retrieves a component of this composite name.
get in interface Name
posn - The 0-based index of the component to retrieve. Must be in the range [0,size()).ArrayIndexOutOfBoundsException - if posn is outside the specified range.public Name getPrefix(int posn)
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.
getPrefix in interface Name
posn - The 0-based index of the component at which to stop. Must be in the range [0,size()].ArrayIndexOutOfBoundsException - If posn is outside the specified range.public Name getSuffix(int posn)
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.
getSuffix in interface Name
posn - The 0-based index of the component at which to start. Must be in the range [0,size()].ArrayIndexOutOfBoundsException - If posn is outside the specified range.public boolean startsWith(Name n)
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.
startsWith in interface Name
n - The possibly null name to check.public boolean endsWith(Name n)
Determines whether a composite name is a suffix of this composite name. A composite name 'n' is a suffix if it 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.
endsWith in interface Name
n - The possibly null name to check.public Name addAll(Name suffix)
throws InvalidNameException Adds the components of a composite name -- in order -- to the end of this composite name.
addAll in interface Name
suffix - The non-null components to add.InvalidNameException - If suffix is not a composite name.public Name addAll(int posn,
Name n)
throws InvalidNameException 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.
addAll in interface Name
n - The non-null components to add.posn - The index in this name at which to add the new components. Must be in the range [0,size()].InvalidNameException - If n is not a composite name.ArrayIndexOutOfBoundsException - If posn is outside the specified range.public Name add(String comp)
throws InvalidNameException Adds a single component to the end of this composite name.
add in interface Name
comp - The non-null component to add.InvalidNameException - If adding comp at end of the name would violate the name's syntax.public Name add(int posn,
String comp)
throws InvalidNameException 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.
add in interface Name
comp - The non-null component to add.posn - The index at which to add the new component. Must be in the range [0,size()].ArrayIndexOutOfBoundsException - If posn is outside the specified range.InvalidNameException - If adding comp at the specified position would violate the name's syntax.public Object remove(int posn)
throws InvalidNameException 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.
remove in interface Name
posn - The index of the component to delete. Must be in the range [0,size()).ArrayIndexOutOfBoundsException - If posn is outside the specified range (includes case where composite name is empty).InvalidNameException - If deleting the component would violate the name's syntax.
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.