File	Doc	Category	Size	Date	Package
Reference.java	API Doc	Java SE 6 API	12838	Tue Jun 10 00:26:20 BST 2008	javax.naming

Reference

• java.lang.Object

Fields Summary
protected String	className Contains the fully-qualified name of the class of the object to which this Reference refers.
protected Vector	addrs Contains the addresses contained in this Reference. Initialized by constructor.
protected String	classFactory Contains the name of the factory class for creating an instance of the object to which this Reference refers. Initialized to null.
protected String	classFactoryLocation Contains the location of the factory class. Initialized to null.
private static final long	serialVersionUID Use serialVersionUID from JNDI 1.1.1 for interoperability

Constructors Summary
public Reference(String className) Constructs a new reference for an object with class name 'className'. Class factory and class factory location are set to null. The newly created reference contains zero addresses. param className The non-null class name of the object to which this reference refers. this.className = className; addrs = new Vector();
public Reference(String className, RefAddr addr) Constructs a new reference for an object with class name 'className' and an address. Class factory and class factory location are set to null. param className The non-null class name of the object to which this reference refers. param addr The non-null address of the object. this.className = className; addrs = new Vector(); addrs.addElement(addr);
public Reference(String className, String factory, String factoryLocation) Constructs a new reference for an object with class name 'className', and the class name and location of the object's factory. param className The non-null class name of the object to which this reference refers. param factory The possibly null class name of the object's factory. param factoryLocation The possibly null location from which to load the factory (e.g. URL) see javax.naming.spi.ObjectFactory see javax.naming.spi.NamingManager#getObjectInstance this(className); classFactory = factory; classFactoryLocation = factoryLocation;
public Reference(String className, RefAddr addr, String factory, String factoryLocation) Constructs a new reference for an object with class name 'className', the class name and location of the object's factory, and the address for the object. param className The non-null class name of the object to which this reference refers. param factory The possibly null class name of the object's factory. param factoryLocation The possibly null location from which to load the factory (e.g. URL) param addr The non-null address of the object. see javax.naming.spi.ObjectFactory see javax.naming.spi.NamingManager#getObjectInstance this(className, addr); classFactory = factory; classFactoryLocation = factoryLocation;

Methods Summary
public void	add(javax.naming.RefAddr addr) Adds an address to the end of the list of addresses. param addr The non-null address to add. addrs.addElement(addr);
public void	add(int posn, javax.naming.RefAddr addr) Adds an address to the list of addresses at index posn. All addresses at index posn or greater are shifted up the list by one (away from index 0). param posn The 0-based index of the list to insert addr. param addr The non-null address to add. exception ArrayIndexOutOfBoundsException If posn not in the specified range. addrs.insertElementAt(addr, posn);
public void	clear() Deletes all addresses from this reference. addrs.setSize(0);
public java.lang.Object	clone() Makes a copy of this reference using its class name list of addresses, class factory name and class factory location. Changes to the newly created copy does not affect this Reference and vice versa. Reference r = new Reference(className, classFactory, classFactoryLocation); Enumeration<RefAddr> a = getAll(); r.addrs = new Vector(); while (a.hasMoreElements()) r.addrs.addElement(a.nextElement()); return r;
public boolean	equals(java.lang.Object obj) Determines whether obj is a reference with the same addresses (in same order) as this reference. The addresses are checked using RefAddr.equals(). In addition to having the same addresses, the Reference also needs to have the same class name as this reference. The class factory and class factory location are not checked. If obj is null or not an instance of Reference, null is returned. param obj The possibly null object to check. return true if obj is equal to this reference; false otherwise. if ((obj != null) && (obj instanceof Reference)) { Reference target = (Reference)obj; // ignore factory information if (target.className.equals(this.className) && target.size() == this.size()) { Enumeration mycomps = getAll(); Enumeration comps = target.getAll(); while (mycomps.hasMoreElements()) if (!(mycomps.nextElement().equals(comps.nextElement()))) return false; return true; } } return false;
public javax.naming.RefAddr	get(java.lang.String addrType) Retrieves the first address that has the address type 'addrType'. String.compareTo() is used to test the equality of the address types. param addrType The non-null address type for which to find the address. return The address in this reference with address type 'addrType; null if no such address exist. int len = addrs.size(); RefAddr addr; for (int i = 0; i < len; i++) { addr = (RefAddr) addrs.elementAt(i); if (addr.getType().compareTo(addrType) == 0) return addr; } return null;
public javax.naming.RefAddr	get(int posn) Retrieves the address at index posn. param posn The index of the address to retrieve. return The address at the 0-based index posn. It must be in the range [0,getAddressCount()). exception ArrayIndexOutOfBoundsException If posn not in the specified range. return ((RefAddr) addrs.elementAt(posn));
public java.util.Enumeration	getAll() Retrieves an enumeration of the addresses in this reference. When addresses are added, changed or removed from this reference, its effects on this enumeration are undefined. return An non-null enumeration of the addresses (RefAddr) in this reference. If this reference has zero addresses, an enumeration with zero elements is returned. return addrs.elements();
public java.lang.String	getClassName() Retrieves the class name of the object to which this reference refers. return The non-null fully-qualified class name of the object. (e.g. "java.lang.String") return className;
public java.lang.String	getFactoryClassLocation() Retrieves the location of the factory of the object to which this reference refers. If it is a codebase, then it is an ordered list of URLs, separated by spaces, listing locations from where the factory class definition should be loaded. return The possibly null string containing the location for loading in the factory's class. return classFactoryLocation;
public java.lang.String	getFactoryClassName() Retrieves the class name of the factory of the object to which this reference refers. return The possibly null fully-qualified class name of the factory. (e.g. "java.lang.String") return classFactory;
public int	hashCode() Computes the hash code of this reference. The hash code is the sum of the hash code of its addresses. return A hash code of this reference as an int. int hash = className.hashCode(); for (Enumeration e = getAll(); e.hasMoreElements();) hash += e.nextElement().hashCode(); return hash;
public java.lang.Object	remove(int posn) Deletes the address at index posn from the list of addresses. All addresses at index greater than posn are shifted down the list by one (towards index 0). param posn The 0-based index of in address to delete. return The address removed. exception ArrayIndexOutOfBoundsException If posn not in the specified range. Object r = addrs.elementAt(posn); addrs.removeElementAt(posn); return r;
public int	size() Retrieves the number of addresses in this reference. return The nonnegative number of addresses in this reference. return addrs.size();
public java.lang.String	toString() Generates the string representation of this reference. The string consists of the class name to which this reference refers, and the string representation of each of its addresses. This representation is intended for display only and not to be parsed. return The non-null string representation of this reference. StringBuffer buf = new StringBuffer("Reference Class Name: " + className + "\n"); int len = addrs.size(); for (int i = 0; i < len; i++) buf.append(get(i).toString()); return buf.toString();