Serializable
, Cloneable
, Comparable<Object>
, Name
public class CompoundName extends Object implements Name
The components of a compound name are numbered. The indexes of a compound 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 compound name has no components.
The string form of the compound name follows the syntax described above. When the components of the compound name are turned into their string representation, the reserved syntax rules described above are applied (e.g. embedded separators are escaped or quoted) so that when the same string is parsed, it will yield the same components of the original compound name.
CompoundName
instance is not synchronized against concurrent multithreaded access. Multiple threads trying to access and modify a CompoundName
should lock the object.Modifier and Type | Field | Description |
---|---|---|
protected Properties |
mySyntax |
Syntax properties for this compound name. |
Modifier | Constructor | Description |
---|---|---|
Constructs a new compound name instance by parsing the string n using the syntax specified by the syntax properties supplied. |
||
protected |
Constructs a new compound name instance using the components specified in comps and syntax. |
Modifier and Type | Method | Description |
---|---|---|
Name |
add |
Adds a single component at a specified position within this compound name. |
Name |
add |
Adds a single component to the end of this compound name. |
Name |
addAll |
Adds the components of a compound name -- in order -- at a specified position within this compound name. |
Name |
addAll |
Adds the components of a compound name -- in order -- to the end of this compound name. |
Object |
clone() |
Creates a copy of this compound name. |
int |
compareTo |
Compares this CompoundName with the specified Object for order. |
boolean |
endsWith |
Determines whether a compound name is a suffix of this compound name. |
boolean |
equals |
Determines whether obj is syntactically equal to this compound name. |
String |
get |
Retrieves a component of this compound name. |
Enumeration |
getAll() |
Retrieves the components of this compound name as an enumeration of strings. |
Name |
getPrefix |
Creates a compound name whose components consist of a prefix of the components in this compound name. |
Name |
getSuffix |
Creates a compound name whose components consist of a suffix of the components in this compound name. |
int |
hashCode() |
Computes the hash code of this compound name. |
boolean |
isEmpty() |
Determines whether this compound name is empty. |
Object |
remove |
Deletes a component from this compound name. |
int |
size() |
Retrieves the number of components in this compound name. |
boolean |
startsWith |
Determines whether a compound name is a prefix of this compound name. |
String |
toString() |
Generates the string representation of this compound name, using the syntax rules of the compound name. |
protected transient Properties mySyntax
protected CompoundName(Enumeration<String> comps, Properties syntax)
comps
- A non-null enumeration of the components to add. Each element of the enumeration is of class String. The enumeration will be consumed to extract its elements.syntax
- A non-null properties that specify the syntax of this compound name. See class description for contents of properties.public CompoundName(String n, Properties syntax) throws InvalidNameException
n
- The non-null string to parse.syntax
- A non-null list of properties that specify the syntax of this compound name. See class description for contents of properties.InvalidNameException
- If 'n' violates the syntax specified by syntax
.public String toString()
public boolean equals(Object obj)
Equality is also defined in terms of the syntax of this compound name. The default implementation of CompoundName uses the syntax properties jndi.syntax.ignorecase and jndi.syntax.trimblanks when comparing two components for equality. If case is ignored, two strings with the same sequence of characters but with different cases are considered equal. If blanks are being trimmed, leading and trailing blanks are ignored for the purpose of the comparison.
Both compound names must have the same number of components.
Implementation note: Currently the syntax properties of the two compound names are not compared for equality. They might be in the future.
public int hashCode()
public Object clone()
public int compareTo(Object obj)
If obj is null or not an instance of CompoundName, ClassCastException is thrown.
See equals() for what it means for two compound names to be equal. If two compound names are equal, 0 is returned.
Ordering of compound names depend on the syntax of the compound name. By default, they follow lexicographical rules for string comparison with the extension that this applies to all the components in the compound name and that comparison of individual components is affected by the jndi.syntax.ignorecase and jndi.syntax.trimblanks properties, identical to how they affect equals(). If this compound name is "lexicographically" lesser than obj, a negative number is returned. If this compound name is "lexicographically" greater than obj, a positive number is returned.
Implementation note: Currently the syntax properties of the two compound names are not compared when checking order. They might be in the future.
compareTo
in interface Comparable<Object>
compareTo
in interface Name
obj
- The non-null object to compare against.ClassCastException
- if obj is not a CompoundName.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)
Implementation note: Currently the syntax properties of n are not used when doing the comparison. They might be in the future.
startsWith
in interface Name
n
- The possibly null compound name to check.public boolean endsWith(Name n)
Implementation note: Currently the syntax properties of n are not used when doing the comparison. They might be in the future.
public Name addAll(Name suffix) throws InvalidNameException
Implementation note: Currently the syntax properties of suffix is not used or checked. They might be in the future.
addAll
in interface Name
suffix
- The non-null components to add.InvalidNameException
- If suffix is not a compound name, or if the addition of the components violates the syntax of this compound name (e.g. exceeding number of components).public Name addAll(int posn, Name n) throws InvalidNameException
Implementation note: Currently the syntax properties of suffix is not used or checked. They might be in the future.
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.ArrayIndexOutOfBoundsException
- If posn is outside the specified range.InvalidNameException
- If n is not a compound name, or if the addition of the components violates the syntax of this compound name (e.g. exceeding number of components).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 compound 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 compound 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 compound name is empty).InvalidNameException
- If deleting the component would violate the compound 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/CompoundName.html