Serializable
, Cloneable
, Comparable<Object>
, Name
public class CompositeName extends Object implements Name
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"} |
CompositeName
s. 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.Modifier | Constructor | Description |
---|---|---|
Constructs a new empty composite name. |
||
Constructs a new composite name instance by parsing the string n using the composite name syntax (left-to-right, slash separated). |
||
protected |
Constructs a new composite name instance using the components specified by 'comps'. |
Modifier and Type | Method | Description |
---|---|---|
Name |
add |
Adds a single component at a specified position within this composite name. |
Name |
add |
Adds a single component to the end of this composite name. |
Name |
addAll |
Adds the components of a composite name -- in order -- at a specified position within this composite name. |
Name |
addAll |
Adds the components of a composite name -- in order -- to the end of this composite name. |
Object |
clone() |
Generates a copy of this composite name. |
int |
compareTo |
Compares this CompositeName with the specified Object for order. |
boolean |
endsWith |
Determines whether a composite name is a suffix of this composite name. |
boolean |
equals |
Determines whether two composite names are equal. |
String |
get |
Retrieves a component of this composite name. |
Enumeration |
getAll() |
Retrieves the components of this composite name as an enumeration of strings. |
Name |
getPrefix |
Creates a composite name whose components consist of a prefix of the components in this composite name. |
Name |
getSuffix |
Creates a composite name whose components consist of a suffix of the components in this composite name. |
int |
hashCode() |
Computes the hash code of this composite name. |
boolean |
isEmpty() |
Determines whether this composite name is empty. |
Object |
remove |
Deletes a component from this composite name. |
int |
size() |
Retrieves the number of components in this composite name. |
boolean |
startsWith |
Determines whether a composite name is a prefix of this composite name. |
String |
toString() |
Generates the string representation of this composite name. |
protected CompositeName(Enumeration<String> comps)
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
n
- The non-null string to parse.InvalidNameException
- If n has invalid composite name syntax.public CompositeName()
isEmpty()
is invoked on it.public String toString()
public boolean equals(Object obj)
public int hashCode()
public int compareTo(Object obj)
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.public Object clone()
public int size()
public boolean isEmpty()
public Enumeration<String> getAll()
public String get(int posn)
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)
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)
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)
startsWith
in interface Name
n
- The possibly null name to check.public boolean endsWith(Name n)
public Name addAll(Name suffix) throws InvalidNameException
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
addAll
in interface Name
posn
- The index in this name at which to add the new components. Must be in the range [0,size()].n
- The non-null components to add.InvalidNameException
- If n is not a composite name.ArrayIndexOutOfBoundsException
- If posn is outside the specified range.public Name add(String comp) throws InvalidNameException
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
add
in interface Name
posn
- The index at which to add the new component. Must be in the range [0,size()].comp
- The non-null component to add.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
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, 2023, 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.
https://docs.oracle.com/en/java/javase/21/docs/api/java.naming/javax/naming/CompositeName.html