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

gnu.javax.naming.ictxImpl.trans

Class GnuName

Implemented Interfaces:
Cloneable, Comparable<T>, Name, Serializable
public class GnuName
extends Object
implements Name
The implementation of the Name.

Fields inherited from interface javax.naming.Name

serialVersionUID

Constructor Summary

GnuName()
Creates the unitialised name.
GnuName(String[] name)
Creates the name, containing from the given chain of the atomic components.
GnuName(String[] buffer, int useFrom, int useLength)
Creates the name that uses the given portion of the array for its components.

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 n)
Returns true if this Name ends with the components of the given Name, false otherwise.
boolean
equals(Object arg0)
The name is equal to other name if they contents are equal.
String
get(int posn)
Gets the component at the given index.
Enumeration<E>
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.
int
hashCode()
Overridden to make consistent with equals.
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 n)
Returns true if this Name starts with the components of the given Name, false otherwise.
String
toString()
Get the string representation, separating the name components by slashes

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GnuName

protected GnuName()
Creates the unitialised name.

GnuName

public GnuName(String[] name)
Creates the name, containing from the given chain of the atomic components.
Parameters:
name - the array, containing the name components.

GnuName

public GnuName(String[] buffer,
               int useFrom,
               int useLength)
Creates the name that uses the given portion of the array for its components.

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.
Specified by:
add in interface Name
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.
Specified by:
add in interface Name
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.
Specified by:
addAll in interface Name
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.
Specified by:
addAll in interface Name
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.
Specified by:
clone in interface 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.
Specified by:
compareTo in interface Name

endsWith

public boolean endsWith(Name n)
Returns true if this Name ends with the components of the given Name, false otherwise.
Specified by:
endsWith in interface Name

equals

public boolean equals(Object arg0)
The name is equal to other name if they contents are equal.
Overrides:
equals in interface Object

get

public String get(int posn)
Gets the component at the given index.
Specified by:
get in interface Name
Throws:
ArrayIndexOutOfBoundsException - if the given index is smaller then zero or greater then or equal to size().

getAll

public Enumeration<E> getAll()
Returns a non-null (but possibly empty) Enumeration of the components of the Name as Strings.
Specified by:
getAll in interface Name

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.
Specified by:
getPrefix in interface Name
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.
Specified by:
getSuffix in interface Name
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().

hashCode

public int hashCode()
Overridden to make consistent with equals.
Overrides:
hashCode in interface Object

isEmpty

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

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.
Specified by:
remove in interface Name
Throws:
InvalidNameException - if the name size reduces below zero.

size

public int size()
Returns the number of components of this Name. The returned number can be zero.
Specified by:
size in interface Name

startsWith

public boolean startsWith(Name n)
Returns true if this Name starts with the components of the given Name, false otherwise.
Specified by:
startsWith in interface Name

toString

public String toString()
Get the string representation, separating the name components by slashes
Overrides:
toString in interface Object
GnuName.java -- implementation of the javax.naming.Name Copyright (C) 2006 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