JavaTM 2 Platform
Standard Ed. 5.0

javax.naming
类 Reference

java.lang.Object
  继承者 javax.naming.Reference
所有已实现的接口:
Serializable, Cloneable
直接已知子类:
LinkRef

public class Reference
extends Object
implements Cloneable, Serializable

此类表示对存在于命名/目录系统以外的对象的引用。

Reference 提供一种记录关于没有直接绑定到命名/目录系统的对象的地址信息的方式。

Reference 由有序地址列表和有关将被引用的对象的类信息组成。列表中的每个地址都标识一个用于相同概念上的对象的通信端点。“通信端点”是指示如何与对象进行联系的信息。例如,它可以是一个网络地址、本地机器内存中的一个位置、同一台机器上的另一个进程等等。列表中地址的顺序对于解释引用的对象工厂而言可能很重要。

出现多个地址的原因有很多,比如重复或者对象在多于一种的通信机制上提供接口。该地址的索引从零开始。

Reference 还包含信息,该信息有助于创建此 Reference 所引用的对象的实例。它包含该对象的类名称,以及用来创建该对象的工厂的类名称和位置。类工厂位置是以空格分隔的 URL 列表,这些 URL 表示用来加载该工厂的类路径。当需要加载工厂类(或任何它所依赖的类或资源)时,将(依次)使用每个 URL 来尝试加载该类。

Reference 实例与多个线程的并发访问不同步。需要并发地访问单个 Reference 的线程应该在它们之间实现同步并提供所需的锁定。

从以下版本开始:
1.3
另请参见:
RefAddr, StringRefAddr, BinaryRefAddr, 序列化表格

字段摘要
protected  Vector<RefAddr> addrs
          包含此 Reference 中所包含的地址。
protected  String classFactory
          包含用来创建此 Reference 所引用的对象实例的工厂类名称。
protected  String classFactoryLocation
          包含工厂类的位置。
protected  String className
          包含此 Reference 所引用的对象类的完全限定名称。
 
构造方法摘要
Reference(String className)
          使用类名称 'className' 构造对某个对象的新引用。
Reference(String className, RefAddr addr)
          使用类名称 'className' 和一个地址构造对某个对象的新引用。
Reference(String className, RefAddr addr, String factory, String factoryLocation)
          使用类名称 'className'、对象工厂的类名称和位置以及对象的地址创建该对某个对象的新引用。
Reference(String className, String factory, String factoryLocation)
          使用类名称 'className' 以及对象工厂的类名称和位置创建对某个对象的新引用。
 
方法摘要
 void add(int posn, RefAddr addr)
          将地址添加到地址列表中的索引 posn 处。
 void add(RefAddr addr)
          将地址添加到地址列表的末尾。
 void clear()
          从此引用中删除所有地址。
 Object clone()
          使用地址的类名称列表、类工厂名称和类工厂位置创建此引用的副本。
 boolean equals(Object obj)
          确定 obj 是否是一个与此引用具有相同地址(按相同顺序)的引用。
 RefAddr get(int posn)
          检索索引 posn 处的地址。
 RefAddr get(String addrType)
          检索地址类型为 'addrType' 的第一个地址。
 Enumeration<RefAddr> getAll()
          返回此索引中的地址所组成的枚举。
 String getClassName()
          检索此引用所引用对象的类名称。
 String getFactoryClassLocation()
          检索此引用所引用对象的工厂的位置。
 String getFactoryClassName()
          检索此引用所引用对象的工厂的类名称。
 int hashCode()
          计算此引用的哈希码。
 Object remove(int posn)
          从地址列表中删除索引 posn 处的地址。
 int size()
          检索此引用中的地址数。
 String toString()
          生成此引用的字符串表示形式。
 
从类 java.lang.Object 继承的方法
finalize, getClass, notify, notifyAll, wait, wait, wait
 

字段详细信息

className

protected String className
包含此 Reference 所引用的对象类的完全限定名称。

另请参见:
Class.getName()

addrs

protected Vector<RefAddr> addrs
包含此 Reference 中所包含的地址。由构造方法初始化。


classFactory

protected String classFactory
包含用来创建此 Reference 所引用的对象实例的工厂类名称。被初始化为 null。


classFactoryLocation

protected String classFactoryLocation
包含工厂类的位置。被初始化为 null。

构造方法详细信息

Reference

public Reference(String className)
使用类名称 'className' 构造对某个对象的新引用。类工厂和类工厂位置都被设置为 null。新创建的引用不包含任何地址。

参数:
className - 此引用所引用对象的非 null 类名称。

Reference

public Reference(String className,
                 RefAddr addr)
使用类名称 'className' 和一个地址构造对某个对象的新引用。类工厂和类工厂位置都被设置为 null。

参数:
className - 此引用所引用对象的非 null 类名称。
addr - 对象的非 null 地址。

Reference

public Reference(String className,
                 String factory,
                 String factoryLocation)
使用类名称 'className' 以及对象工厂的类名称和位置创建对某个对象的新引用。

参数:
className - 此引用所引用对象的非 null 类名称。
factory - 对象工厂的类名称(可能为 null)。
factoryLocation - 加载工厂的、可能为 null 的位置(例如 URL)
另请参见:
ObjectFactory, NamingManager.getObjectInstance(java.lang.Object, javax.naming.Name, javax.naming.Context, java.util.Hashtable)

Reference

public Reference(String className,
                 RefAddr addr,
                 String factory,
                 String factoryLocation)
使用类名称 'className'、对象工厂的类名称和位置以及对象的地址创建该对某个对象的新引用。

参数:
className - 此引用所引用对象的非 null 类名称。
factory - 对象工厂的类名称(可能为 null)。
factoryLocation - 加载工厂的、可能为 null 的位置(例如 URL)
addr - 对象的非 null 地址。
另请参见:
ObjectFactory, NamingManager.getObjectInstance(java.lang.Object, javax.naming.Name, javax.naming.Context, java.util.Hashtable)
方法详细信息

getClassName

public String getClassName()
检索此引用所引用对象的类名称。

返回:
该对象的非 null 完全限定类名称。(例如 "java.lang.String")

getFactoryClassName

public String getFactoryClassName()
检索此引用所引用对象的工厂的类名称。

返回:
该工厂的完全限定类名称(可能为 null)。(例如 "java.lang.String")

getFactoryClassLocation

public String getFactoryClassLocation()
检索此引用所引用对象的工厂的位置。如果是一个代码基,则它是一个以空格分隔的有序 URL 列表,该列表列出了应该加载工厂类定义的位置。

返回:
包含用来加载工厂类的地址的字符串(可能为 null)。

get

public RefAddr get(String addrType)
检索地址类型为 'addrType' 的第一个地址。String.compareTo() 用于测试地址类型的相等性。

参数:
addrType - 用来查找地址的非 null 地址类型。
返回:
此引用中地址类型为 'addrType 的地址;如果不存在这样的地址,则返回 null。

get

public RefAddr get(int posn)
检索索引 posn 处的地址。

参数:
posn - 要检索的地址的索引。
返回:
索引 posn(从 0 开始)处的地址。必须在范围 [0,getAddressCount()) 内。
抛出:
ArrayIndexOutOfBoundsException - 如果 posn 不在指定的范围内。

getAll

public Enumeration<RefAddr> getAll()
返回此索引中的地址所组成的枚举。当在此引用中添加、更改或移除地址时,对此枚举的影响是不确定的。

返回:
此引用中的地址 (RefAddr) 所组成的非 null 枚举。如果此索引中没有任何地址,则返回一个不带任何元素的枚举。

size

public int size()
检索此引用中的地址数。

返回:
此引用中的非负地址数。

add

public void add(RefAddr addr)
将地址添加到地址列表的末尾。

参数:
addr - 要添加的非 null 地址。

add

public void add(int posn,
                RefAddr addr)
将地址添加到地址列表中的索引 posn 处。索引 posn 或大于该索引的所有地址都将在该列表中上移(远离索引 0)一位。

参数:
posn - 列表中要插入 addr 的索引(从 0 开始)。
addr - 要插入的非 null 地址。
抛出:
ArrayIndexOutOfBoundsException - 如果 posn 并不在指定的范围内。

remove

public Object remove(int posn)
从地址列表中删除索引 posn 处的地址。索引大于 posn 的所有地址都将在该列表中下移(朝向索引 0)一位。

参数:
posn - 要删除的地址的索引(从 0 开始)。
返回:
移除的地址。
抛出:
ArrayIndexOutOfBoundsException - 如果 posn 不在指定的范围内。

clear

public void clear()
从此引用中删除所有地址。


equals

public boolean equals(Object obj)
确定 obj 是否是一个与此引用具有相同地址(按相同顺序)的引用。可以使用 RefAddr.equals() 检查该地址。除了具有相同地址之外,Reference 还应该与此引用具有相同的类名称。不检查类工厂和类工厂位置。如果 obj 为 null 或者不是一个 Reference 实例,则返回 null。

覆盖:
Object 中的 equals
参数:
obj - 要检查的对象(可能为 null)。
返回:
如果 obj 等于此引用,则返回 true,否则返回 false。
另请参见:
Object.hashCode(), Hashtable

hashCode

public int hashCode()
计算此引用的哈希码。该哈希码是其地址的哈希玛的总和。

覆盖:
Object 中的 hashCode
返回:
此引用 int 形式的哈希码。
另请参见:
Object.equals(java.lang.Object), Hashtable

toString

public String toString()
生成此引用的字符串表示形式。该字符串由此引用所引用的类名称及其每个地址的字符串表示形式组成。此表示形式只用于显示,不会被解析。

覆盖:
Object 中的 toString
返回:
此引用的非 null 字符串表示形式。

clone

public Object clone()
使用地址的类名称列表、类工厂名称和类工厂位置创建此引用的副本。对新创建副本的更改不会影响此 Reference,反之亦然。

覆盖:
Object 中的 clone
返回:
此实例的一个克隆。
另请参见:
Cloneable

JavaTM 2 Platform
Standard Ed. 5.0

提交错误或意见
有关更多的 API 参考资料和开发人员文档,请参阅 Java 2 SDK SE 开发人员文档。该文档包含更详细的、面向开发人员的描述,以及总体概述、术语定义、使用技巧和工作代码示例。

版权所有 2004 Sun Microsystems, Inc. 保留所有权利。 请遵守许可证条款。另请参阅文档重新分发政策