public class CompoundName extends Object implements Name
This class represents a compound name -- a name from a hierarchical name space. Each component in a compound name is an atomic 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.protected transient javax.naming.NameImpl impl
Implementation of this compound name. This field is initialized by the constructors and cannot be null. It should be treated as a read-only variable by subclasses.
protected transient Properties mySyntax
Syntax properties for this compound name. This field is initialized by the constructors and cannot be null. It should be treated as a read-only variable by subclasses. Any necessary changes to mySyntax should be made within constructors and not after the compound name has been instantiated.
protected CompoundName(Enumeration<String> comps, Properties syntax)
Constructs a new compound name instance using the components specified in comps and syntax. This protected method is intended to be to be used by subclasses of CompoundName when they override methods such as clone(), getPrefix(), getSuffix().
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
Constructs a new compound name instance by parsing the string n using the syntax specified by the syntax properties supplied.
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()
Generates the string representation of this compound name, using the syntax rules of the compound name. The syntax rules are described in the class description. An empty component is represented by an empty string. The string representation thus generated can be passed to the CompoundName constructor with the same syntax properties to create a new equivalent compound name.
toString
in class Object
public boolean equals(Object obj)
Determines whether obj is syntactically equal to this compound name. If obj is null or not a CompoundName, false is returned. Two compound names are equal if each component in one is "equal" to the corresponding component in the other.
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.
equals
in class Object
obj
- The possibly null object to compare against.compareTo(java.lang.Object obj)
public int hashCode()
Computes the hash code of this compound name. The hash code is the sum of the hash codes of the "canonicalized" forms of individual components of this compound name. Each component is "canonicalized" according to the compound name's syntax before its hash code is computed. For a case-insensitive name, for example, the uppercased form of a name has the same hash code as its lowercased equivalent.
hashCode
in class Object
Object.equals(java.lang.Object)
, System.identityHashCode(java.lang.Object)
public Object clone()
Creates a copy of this compound name. Changes to the components of this compound name won't affect the new copy and vice versa. The clone and this compound name share the same syntax.
clone
in interface Name
clone
in class Object
Cloneable
public int compareTo(Object obj)
Compares this CompoundName 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 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.equals(java.lang.Object)
public int size()
Retrieves the number of components in this compound name.
size
in interface Name
public boolean isEmpty()
Determines whether this compound name is empty. A compound name is empty if it has zero components.
isEmpty
in interface Name
public Enumeration<String> getAll()
Retrieves the components of this compound name as an enumeration of strings. The effects of updates to this compound name on this enumeration is undefined.
getAll
in interface Name
public String get(int posn)
Retrieves a component of this compound 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 compound name whose components consist of a prefix of the components in this compound name. The result and this compound name share the same syntax. Subsequent changes to this compound name does not affect the name that is returned and vice versa.
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 compound name whose components consist of a suffix of the components in this compound name. The result and this compound name share the same syntax. Subsequent changes to this compound 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 compound name is a prefix of this compound name. A compound name 'n' is a prefix if it is equal to getPrefix(n.size())--in other words, this compound name starts with 'n'. If n is null or not a compound name, false is returned.
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)
Determines whether a compound name is a suffix of this compound name. A compound name 'n' is a suffix if it it is equal to getSuffix(size()-n.size())--in other words, this compound name ends with 'n'. If n is null or not a compound name, false is returned.
Implementation note: Currently the syntax properties of n are not used when doing the comparison. They might be in the future.
endsWith
in interface Name
n
- The possibly null compound name to check.public Name addAll(Name suffix) throws InvalidNameException
Adds the components of a compound name -- in order -- to the end of this compound name.
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
Adds the components of a compound name -- in order -- at a specified position within this compound name. Components of this compound name at or after the index of the first new component are shifted up (away from index 0) to accommodate the new components.
Implementation note: Currently the syntax properties of suffix is not used or checked. They might be in the future.
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()].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
Adds a single component to the end of this compound name.
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
Adds a single component at a specified position within this compound name. Components of this compound 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 compound name's syntax.public Object remove(int posn) throws InvalidNameException
Deletes a component from this compound name. The component of this compound 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 compound name is empty).InvalidNameException
- If deleting the component would violate the compound 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.