JavaTM 2 Platform
Standard Ed. 5.0

javax.naming.directory
接口 Attributes

所有超级接口:
Cloneable, Serializable
所有已知实现类:
BasicAttributes

public interface Attributes
extends Cloneable, Serializable

此接口表示属性的集合。

在目录中,命名的对象可以与其属性关联。Attributes 接口表示属性的集合。例如,可以从目录请求与对象关联的属性。这些属性在实现 Attributes 接口的对象中返回。

实现 Attributes 接口的对象中的属性是无序的。该对象可以有零个或多个属性。Attributes 或者区分大小写或者不区分大小写(忽略大小写)。此属性在创建 Attributes 对象时确定。(有关示例,请参阅 BasicAttributes 构造方法)。在不区分大小写的 Attributes 中,搜索属性或添加属性时将忽略其属性标识符的大小写。在区分大小写的 Attributes 中,大小写至关重要。

注意,更新 Attribute(如添加或移除属性)对目录中的相应表示形式没有影响。只有使用 DirContext 接口中的操作才能实现对目录的更新。

从以下版本开始:
1.3
另请参见:
DirContext.getAttributes(javax.naming.Name), DirContext.modifyAttributes(javax.naming.Name, int, javax.naming.directory.Attributes), DirContext.bind(javax.naming.Name, java.lang.Object, javax.naming.directory.Attributes), DirContext.rebind(javax.naming.Name, java.lang.Object, javax.naming.directory.Attributes), DirContext.createSubcontext(javax.naming.Name, javax.naming.directory.Attributes), DirContext.search(javax.naming.Name, javax.naming.directory.Attributes, java.lang.String[]), BasicAttributes

方法摘要
 Object clone()
          对属性集进行复制。
 Attribute get(String attrID)
          利用属性集中的给定属性 id 检索属性。
 NamingEnumeration<? extends Attribute> getAll()
          检索属性集中属性的枚举。
 NamingEnumeration<String> getIDs()
          检索属性集中属性的 id 的枚举。
 boolean isCaseIgnored()
          确定在检索或添加属性时属性集是否忽略属性标识符的大小写。
 Attribute put(Attribute attr)
          向属性集中添加新属性。
 Attribute put(String attrID, Object val)
          向属性集中添加新属性。
 Attribute remove(String attrID)
          从属性集中移除属性 id 为 'attrID' 的属性。
 int size()
          在属性集中检索属性数。
 

方法详细信息

isCaseIgnored

boolean isCaseIgnored()
确定在检索或添加属性时属性集是否忽略属性标识符的大小写。

返回:
如果忽略大小写,则返回 true;否则,返回 false。

size

int size()
在属性集中检索属性数。

返回:
此属性集中的非负属性数。

get

Attribute get(String attrID)
利用属性集中的给定属性 id 检索属性。

参数:
attrID - 要检索的属性的非 null id。如果此属性集忽略其属性 id 的字符大小写,则忽略 attrID 的大小写。
返回:
由 attrID 标识的属性;如果找不到,则返回 null。
另请参见:
put(java.lang.String, java.lang.Object), remove(java.lang.String)

getAll

NamingEnumeration<? extends Attribute> getAll()
检索属性集中属性的枚举。在此枚举上更新此属性集的结果是不确定的。

返回:
此属性集中属性的非 null 枚举。每个枚举元素都属于 Attribute 类。如果属性集的属性数为零,则返回空枚举。

getIDs

NamingEnumeration<String> getIDs()
检索属性集中属性的 id 的枚举。在此枚举上更新此属性集的结果是不确定的。

返回:
此属性集中属性 id 的非 null 枚举。每个枚举元素都属于 String 类。如果属性集的属性数为零,则返回空枚举。

put

Attribute put(String attrID,
              Object val)
向属性集中添加新属性。

参数:
attrID - 要添加的属性的非 null id。如果属性集忽略其属性 id 的字符大小写,则忽略 attrID 的大小写。
val - 要添加的属性的可能为 null 的值。如果为 null,则属性不具有任何值。
返回:
以前在此属性集中的具有 attrID 的 Attribute;如果不存在这种属性,则返回 null。
另请参见:
remove(java.lang.String)

put

Attribute put(Attribute attr)
向属性集中添加新属性。

参数:
attr - 要添加的非 null 属性。如果属性集忽略其属性 id 的字符大小写,则忽略 attr 标识符的大小写。
返回:
以前在此属性集中的与 attr 具有相同 ID 的 Attribute;如果不存在这种属性,则返回 null。
另请参见:
remove(java.lang.String)

remove

Attribute remove(String attrID)
从属性集中移除属性 id 为 'attrID' 的属性。如果该属性不存在,则忽略。

参数:
attrID - 要移除的属性的非 null id。如果属性集忽略其属性 id 的字符大小写,则忽略 attrID 的大小写。
返回:
以前在属性集中的与 attrID 具有相同 ID 的 Attribute;如果不存在这种属性,则返回 null。

clone

Object clone()
对属性集进行复制。新集合包含与初始集合相同的属性:这些属性不是其本身的克隆。对副本的更改不会影响原件,反之亦然。

返回:
此属性集的非 null 副本。

JavaTM 2 Platform
Standard Ed. 5.0

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

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