Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

javax.naming

Interface Name

All Superinterfaces:
Cloneable, Comparable<T>, Serializable
Known Implementing Classes:
CompositeName, CompoundName
public interface Name
extends Cloneable, Serializable, Comparable<T>
Interface descriping a name build up from different components. The components are represented as Strings which are ordered from most significant to least significant. There are methods to get the number of components. Methods to get a particular component or group of components. Components can be added as Strings or Names and a component can be removed from any position in the Name. A Name can be compared to another Name and it can be checked if a particular Name starts or ends with the same components as another Name. Finally Names can be serialized and cloned.

Since Names can be empty (have no components) methods that return a Name will never return null.

Since:
1.3

Field Summary

static long
serialVersionUID

Method Summary

Name
add(int posn, String comp)
Inserts the given String component to this Name at the given index.
Name
add(String comp)
Adds the given String component to the end of this Name.
Name
addAll(int posn, Name n)
Inserts all the components of the given Name to this Name at the given index.
Name
addAll(Name suffix)
Adds all the components of the given Name to the end of this Name.
Object
clone()
Returns a clone of this Name.
int
compareTo(Object obj)
Compares the given object to this Name.
boolean
endsWith(Name name)
Returns true if this Name ends with the components of the given Name, false otherwise.
String
get(int i)
Gets the component at the given index.
Enumeration
getAll()
Returns a non-null (but possibly empty) Enumeration of the components of the Name as Strings.
Name
getPrefix(int posn)
Returns the components till the given index as a Name.
Name
getSuffix(int posn)
Returns the components from the given index till the end as a Name.
boolean
isEmpty()
Returns true if the number of components of this Name is zero, false otherwise.
Object
remove(int posn)
Removes the component at the given index from this Name.
int
size()
Returns the number of components of this Name.
boolean
startsWith(Name name)
Returns true if this Name starts with the components of the given Name, false otherwise.

Methods inherited from interface java.lang.Comparable<T>

compareTo

Field Details

serialVersionUID

public static final long serialVersionUID
Field Value:
-3617482732056931635L

Method Details

add

public Name add(int posn,
                String comp)
            throws InvalidNameException
Inserts the given String component to this Name at the given index. The method modifies the current Name and then returns it.
Throws:
ArrayIndexOutOfBoundsException - if the given index is smaller then zero or greater then or equal to size().
InvalidNameException - if the given String is not a valid component for this Name.

add

public Name add(String comp)
            throws InvalidNameException
Adds the given String component to the end of this Name. The method modifies the current Name and then returns it.
Throws:
InvalidNameException - if the given String is not a valid component for this Name.

addAll

public Name addAll(int posn,
                   Name n)
            throws InvalidNameException
Inserts all the components of the given Name to this Name at the given index. Components after this index (if any) are shifted up. The method modifies the current Name and then returns it.
Throws:
ArrayIndexOutOfBoundsException - if the given index is smaller then zero or greater then or equal to size().
InvalidNameException - if any of the given components is not a valid component for this Name.

addAll

public Name addAll(Name suffix)
            throws InvalidNameException
Adds all the components of the given Name to the end of this Name. The method modifies the current Name and then returns it.
Throws:
InvalidNameException - if any of the given components is not a valid component for this Name.

clone

public Object clone()
Returns a clone of this Name. It will be a deep copy of all the components of the Name so that changes to components of the components does not change the component in this Name.
Overrides:
clone in interface Object

compareTo

public int compareTo(Object obj)
Compares the given object to this Name. Returns a negative value if the given Object is smaller then this Name, a positive value if the Object is bigger, and zero if the are equal. If the Object is not of a class that can be compared to the class of this Name then a ClassCastException is thrown. Note that it is not guaranteed that Names implemented in different classes can be compared. The definition of smaller, bigger and equal is up to the actual implementing class.

endsWith

public boolean endsWith(Name name)
Returns true if this Name ends with the components of the given Name, false otherwise.

get

public String get(int i)
Gets the component at the given index.
Throws:
ArrayIndexOutOfBoundsException - if the given index is smaller then zero or greater then or equal to size().

getAll

public Enumeration getAll()
Returns a non-null (but possibly empty) Enumeration of the components of the Name as Strings.

getPrefix

public Name getPrefix(int posn)
Returns the components till the given index as a Name. The returned Name can be modified without changing the original.
Parameters:
posn - the ending position, exclusive
Throws:
ArrayIndexOutOfBoundsException - if the given index is smaller then zero or greater then or equal to size().

getSuffix

public Name getSuffix(int posn)
Returns the components from the given index till the end as a Name. The returned Name can be modified without changing the original.
Parameters:
posn - the starting position, inclusive. If it is equal to the size of the name, the empty name is returned.
Throws:
ArrayIndexOutOfBoundsException - if the given index is smaller then zero or greater then or equal to size().

isEmpty

public boolean isEmpty()
Returns true if the number of components of this Name is zero, false otherwise.

remove

public Object remove(int posn)
            throws InvalidNameException
Removes the component at the given index from this Name. The method modifies the current Name and then returns it.
Throws:
InvalidNameException - if the given String is not a valid component for this Name.

size

public int size()
Returns the number of components of this Name. The returned number can be zero.

startsWith

public boolean startsWith(Name name)
Returns true if this Name starts with the components of the given Name, false otherwise.
Name.java -- Name build up from different components Copyright (C) 2000, 2001, 2004, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About