public interface Name extends Cloneable, Serializable, Comparable<Object>
The Name
interface represents a generic name -- an ordered sequence of components. It can be a composite name (names that span multiple namespaces), or a compound name (names that are used within individual hierarchical naming systems).
There can be different implementations of Name
; for example, composite names, URLs, or namespace-specific compound names.
The components of a name are numbered. The indexes of a 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 name has no components.
None of the methods in this interface accept null as a valid value for a parameter that is a name or a name component. Likewise, methods that return a name or name component never return null.
An instance of a Name
may not be synchronized against concurrent multithreaded access if that access is not read-only.
static final long serialVersionUID
The class fingerprint that is set to indicate serialization compatibility with a previous version of the class.
Object clone()
Generates a new copy of this name. Subsequent changes to the components of this name will not affect the new copy, and vice versa.
Object.clone()
int compareTo(Object obj)
Compares this name with another name for order. Returns a negative integer, zero, or a positive integer as this name is less than, equal to, or greater than the given name.
As with Object.equals()
, the notion of ordering for names depends on the class that implements this interface. For example, the ordering may be based on lexicographical ordering of the name components. Specific attributes of the name, such as how it treats case, may affect the ordering. In general, two names of different classes may not be compared.
compareTo
in interface Comparable<Object>
obj
- the non-null object to compare against.ClassCastException
- if obj is not a Name
of a type that may be compared with this nameComparable.compareTo(Object)
int size()
Returns the number of components in this name.
boolean isEmpty()
Determines whether this name is empty. An empty name is one with zero components.
Enumeration<String> getAll()
Retrieves the components of this name as an enumeration of strings. The effect on the enumeration of updates to this name is undefined. If the name has zero components, an empty (non-null) enumeration is returned.
String get(int posn)
Retrieves a component of this 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 rangeName getPrefix(int posn)
Creates a name whose components consist of a prefix of the components of this name. Subsequent changes to this name will not affect the name that is returned and vice versa.
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 rangeName getSuffix(int posn)
Creates a name whose components consist of a suffix of the components in this name. Subsequent changes to this name do not affect the name that is returned and vice versa.
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 rangeboolean startsWith(Name n)
Determines whether this name starts with a specified prefix. A name n
is a prefix if it is equal to getPrefix(n.size())
.
n
- the name to checkn
is a prefix of this name, false otherwiseboolean endsWith(Name n)
Determines whether this name ends with a specified suffix. A name n
is a suffix if it is equal to getSuffix(size()-n.size())
.
n
- the name to checkn
is a suffix of this name, false otherwiseName addAll(Name suffix) throws InvalidNameException
Adds the components of a name -- in order -- to the end of this name.
suffix
- the components to addInvalidNameException
- if suffix
is not a valid name, or if the addition of the components would violate the syntax rules of this nameName addAll(int posn, Name n) throws InvalidNameException
Adds the components of a name -- in order -- at a specified position within this name. Components of this name at or after the index of the first new component are shifted up (away from 0) to accommodate the new components.
n
- the components to addposn
- 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 rangeInvalidNameException
- if n
is not a valid name, or if the addition of the components would violate the syntax rules of this nameName add(String comp) throws InvalidNameException
Adds a single component to the end of this name.
comp
- the component to addInvalidNameException
- if adding comp
would violate the syntax rules of this nameName add(int posn, String comp) throws InvalidNameException
Adds a single component at a specified position within this name. Components of this name at or after the index of the new component are shifted up by one (away from index 0) to accommodate the new component.
comp
- the component to addposn
- the index at which to add the new component. Must be in the range [0,size()].ArrayIndexOutOfBoundsException
- if posn is outside the specified rangeInvalidNameException
- if adding comp
would violate the syntax rules of this nameObject remove(int posn) throws InvalidNameException
Removes a component from this name. The component of this name at the specified position is removed. Components with indexes greater than this position are shifted down (toward index 0) by one.
posn
- the index of the component to remove. Must be in the range [0,size()).ArrayIndexOutOfBoundsException
- if posn is outside the specified rangeInvalidNameException
- if deleting the component would violate the syntax rules of the name
© 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.