javax.naming

Class CompositeName

Implemented Interfaces:
Cloneable, Comparable, Name, Serializable

public class CompositeName
extends Object
implements Name, Cloneable, Serializable

Represents names that may span over several namespaces. For instance, the composite name http://www.gnu.org/software/classpath/index.html spans over three namespaces (the protocol http, the web server location (www.gnu.org) and the index.html location on the server).
See Also:
Serialized Form

Fields inherited from interface javax.naming.Name

serialVersionUID

Constructor Summary

CompositeName()
The basic constructor.
CompositeName(String n)
CompositeName(Enumeration comps)

Method Summary

Name
add(int posn, String comp)
Name
add(String comp)
Name
addAll(int posn, Name n)
Name
addAll(Name suffix)
Object
clone()
This method may be called to create a new copy of the Object.
int
compareTo(Object obj)
Compares this object with another, and returns a numerical result based on the comparison.
boolean
endsWith(Name n)
boolean
equals(Object obj)
Determine whether this Object is semantically equal to another Object.
String
get(int posn)
Enumeration
getAll()
Name
getPrefix(int posn)
Name
getSuffix(int posn)
int
hashCode()
Get a value that represents this Object, as uniquely as possible within the confines of an int.
boolean
isEmpty()
Object
remove(int posn)
int
size()
boolean
startsWith(Name n)
String
toString()
Convert this Object to a human-readable String.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CompositeName

public CompositeName()
The basic constructor. Object is special, because it has no superclass, so there is no call to super().

CompositeName

public CompositeName(String n)
            throws InvalidNameException

CompositeName

protected CompositeName(Enumeration comps)

Method Details

add

public Name add(int posn,
                String comp)
            throws InvalidNameException
Specified by:
add in interface Name

add

public Name add(String comp)
            throws InvalidNameException
Specified by:
add in interface Name

addAll

public Name addAll(int posn,
                   Name n)
            throws InvalidNameException
Specified by:
addAll in interface Name

addAll

public Name addAll(Name suffix)
            throws InvalidNameException
Specified by:
addAll in interface Name

clone

public Object clone()
This method may be called to create a new copy of the Object. The typical behavior is as follows:
  • o == o.clone() is false
  • o.getClass() == o.clone().getClass() is true
  • o.equals(o) is true

However, these are not strict requirements, and may be violated if necessary. Of the three requirements, the last is the most commonly violated, particularly if the subclass does not override Object.equals(Object).

If the Object you call clone() on does not implement Cloneable (which is a placeholder interface), then a CloneNotSupportedException is thrown. Notice that Object does not implement Cloneable; this method exists as a convenience for subclasses that do.

Object's implementation of clone allocates space for the new Object using the correct class, without calling any constructors, and then fills in all of the new field values with the old field values. Thus, it is a shallow copy. However, subclasses are permitted to make a deep copy.

All array types implement Cloneable, and override this method as follows (it should never fail):

 public Object clone()
 {
   try
     {
       super.clone();
     }
   catch (CloneNotSupportedException e)
     {
       throw new InternalError(e.getMessage());
     }
 }
 
Specified by:
clone in interface Name
Overrides:
clone in interface Object
Returns:
a copy of the Object
See Also:
Cloneable

compareTo

public int compareTo(Object obj)
Compares this object with another, and returns a numerical result based on the comparison. If the result is negative, this object sorts less than the other; if 0, the two are equal, and if positive, this object sorts greater than the other. To translate this into boolean, simply perform o1.compareTo(o2) <op> 0, where op is one of <, <=, =, !=, >, or >=.

You must make sure that the comparison is mutual, ie. sgn(x.compareTo(y)) == -sgn(y.compareTo(x)) (where sgn() is defined as -1, 0, or 1 based on the sign). This includes throwing an exception in either direction if the two are not comparable; hence, compareTo(null) should always throw an Exception.

You should also ensure transitivity, in two forms: x.compareTo(y) > 0 && y.compareTo(z) > 0 implies x.compareTo(z) > 0; and x.compareTo(y) == 0 implies x.compareTo(z) == y.compareTo(z).

Specified by:
compareTo in interface Name
compareTo in interface Comparable
Parameters:
Returns:
an integer describing the comparison
Throws:
NullPointerException - if o is null
ClassCastException - if o cannot be compared

endsWith

public boolean endsWith(Name n)
Specified by:
endsWith in interface Name

equals

public boolean equals(Object obj)
Determine whether this Object is semantically equal to another Object.

There are some fairly strict requirements on this method which subclasses must follow:

  • It must be transitive. If a.equals(b) and b.equals(c), then a.equals(c) must be true as well.
  • It must be symmetric. a.equals(b) and b.equals(a) must have the same value.
  • It must be reflexive. a.equals(a) must always be true.
  • It must be consistent. Whichever value a.equals(b) returns on the first invocation must be the value returned on all later invocations.
  • a.equals(null) must be false.
  • It must be consistent with hashCode(). That is, a.equals(b) must imply a.hashCode() == b.hashCode(). The reverse is not true; two objects that are not equal may have the same hashcode, but that has the potential to harm hashing performance.

This is typically overridden to throw a ClassCastException if the argument is not comparable to the class performing the comparison, but that is not a requirement. It is legal for a.equals(b) to be true even though a.getClass() != b.getClass(). Also, it is typical to never cause a NullPointerException.

In general, the Collections API (java.util) use the equals method rather than the == operator to compare objects. However, IdentityHashMap is an exception to this rule, for its own good reasons.

The default implementation returns this == o.

Overrides:
equals in interface Object
Parameters:
obj - the Object to compare to
Returns:
whether this Object is semantically equal to another

get

public String get(int posn)
Specified by:
get in interface Name

getAll

public Enumeration getAll()
Specified by:
getAll in interface Name

getPrefix

public Name getPrefix(int posn)
Specified by:
getPrefix in interface Name

getSuffix

public Name getSuffix(int posn)
Specified by:
getSuffix in interface Name

hashCode

public int hashCode()
Get a value that represents this Object, as uniquely as possible within the confines of an int.

There are some requirements on this method which subclasses must follow:

  • Semantic equality implies identical hashcodes. In other words, if a.equals(b) is true, then a.hashCode() == b.hashCode() must be as well. However, the reverse is not necessarily true, and two objects may have the same hashcode without being equal.
  • It must be consistent. Whichever value o.hashCode() returns on the first invocation must be the value returned on all later invocations as long as the object exists. Notice, however, that the result of hashCode may change between separate executions of a Virtual Machine, because it is not invoked on the same object.

Notice that since hashCode is used in Hashtable and other hashing classes, a poor implementation will degrade the performance of hashing (so don't blindly implement it as returning a constant!). Also, if calculating the hash is time-consuming, a class may consider caching the results.

The default implementation returns System.identityHashCode(this)

Overrides:
hashCode in interface Object
Returns:
the hash code for this Object

isEmpty

public boolean isEmpty()
Specified by:
isEmpty in interface Name

remove

public Object remove(int posn)
            throws InvalidNameException
Specified by:
remove in interface Name

size

public int size()
Specified by:
size in interface Name

startsWith

public boolean startsWith(Name n)
Specified by:
startsWith in interface Name

toString

public String toString()
Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() and such.

It is typical, but not required, to ensure that this method never completes abruptly with a RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).

Overrides:
toString in interface Object
Returns:
the String representing this Object, which may be null

CompositeName.java -- Copyright (C) 2001, 2005, 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.