javax.naming.directory
接口 Attribute

所有超级接口：

Cloneable, Serializable

所有已知实现类：

BasicAttribute

public interface Attribute
extends Cloneable, Serializable

此接口表示与命名对象关联的属性。

在目录中，命名的对象可以与其属性关联。Attribute 接口表示与命名对象关联的属性。属性包含 0 个或多个（可能为 null 的）值。属性值可以是有序的也可以是无序的（参阅 isOrdered()）。如果值是无序的，则不允许重复。如果值是有序的，则允许重复。

属性的内容和表示形式及其值均由属性的模式 定义。模式包含关于属性语法和属性其他性质的信息。有关基础目录服务支持模式时如何获取关于属性的模式信息的详细信息，请参阅 getAttributeDefinition() 和 getAttributeSyntaxDefinition()。

两个属性的相等性由实现类确定。简单的实现可以使用 Object.equals() 来确定属性值的相等性，而较复杂的实现可能使用模式信息来确定相等性。类似地，一个实现可能提供仅返回传递给其构造方法的值的静态存储结构，另一个实现可能定义 get() 和 getAll() 从目录动态获取值。

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

从以下版本开始：

1.3

另请参见：

BasicAttribute

字段摘要

static long

serialVersionUID 使用 JNDI 1.1.1 中的 serialVersionUID 获取互操作性。

方法摘要

void	add(int ix, Object attrVal) 将属性值添加到属性值的有序列表中。
boolean	add(Object attrVal) 向属性添加新值。
void	clear() 从此属性移除所有值。
Object	clone() 对属性进行复制。
boolean	contains(Object attrVal) 确定某个值是否在属性中。
Object	get() 检索此属性的其中一个值。
Object	get(int ix) 从属性值的有序列表中检索属性值。
NamingEnumeration<?>	getAll() 检索属性值的枚举。
DirContext	getAttributeDefinition() 检索属性的模式定义。
DirContext	getAttributeSyntaxDefinition() 检索与属性关联的语法定义。
String	getID() 检索此属性的 id。
boolean	isOrdered() 确定此属性的值是否是有序的。
Object	remove(int ix) 从属性值的有序列表中移除属性值。
boolean	remove(Object attrval) 从属性中移除指定值。
Object	set(int ix, Object attrVal) 设置属性值的有序列表中的属性值。
int	size() 检索此属性中的值数。

字段详细信息

serialVersionUID

static final long serialVersionUID

使用 JNDI 1.1.1 中的 serialVersionUID 获取互操作性。

另请参见：

常量字段值

方法详细信息

getAll

NamingEnumeration<?> getAll()
                            throws NamingException

检索属性值的枚举。如果正在进行枚举时添加、更改或移除属性值，则此枚举的行为是不确定的。如果属性值是有序的，则枚举的项将是有序的。

返回：

属性值的非 null 枚举。每个枚举元素都可能是一个 null 对象。对象的类就是属性值的类。如果属性值为 null，则元素为 null。如果属性的值为零，则返回空枚举。

抛出：

NamingException - 如果检索值时遇到命名异常。

另请参见：

isOrdered()

get

Object get()
           throws NamingException

检索此属性的其中一个值。如果属性具有多个值并且是无序的，则返回其中的任意一个值。如果属性具多个值并且是有序的，则返回第一个值。

返回：

表示属性值之一的可能为 null 的对象。如果属性值为 null，则返回 null。

抛出：

NamingException - 如果检索值时遇到命名异常。

NoSuchElementException - 如果此属性没有值。

size

int size()

检索此属性中的值数。

返回：

此属性中的非负值数。

getID

String getID()

检索此属性的 id。

返回：

此属性的 id。它不能为 null。

contains

boolean contains(Object attrVal)

确定某个值是否在属性中。相等性由实现确定，其可能使用 Object.equals() 或模式信息来确定相等性。

参数：

attrVal - 要检查的可能为 null 的值。如果为 null，则检查属性是否具有其值不为 null 的属性值。

返回：

如果 attrVal 是此属性的值之一，则返回 true；否则返回 false。

另请参见：

Object.equals(java.lang.Object), BasicAttribute.equals(java.lang.Object)

add

boolean add(Object attrVal)

向属性添加新值。如果属性值是无序的，并且 attrVal 已在属性中，则此方法不执行任何操作。如果属性值是有序的，则 attrVal 将被添加到属性值列表的末尾。

相等性由实现确定，其可能使用 Object.equals() 或模式信息来确定相等性。

参数：

attrVal - 要添加的可能为 null 的新值。如果为 null，则将 null 作为属性值添加。

返回：

如果添加了值，则返回 true；否则返回 false。

remove

boolean remove(Object attrval)

从属性中移除指定值。如果 attrval 不在属性中，则此方法不执行任何操作。如果属性值是有序的，则移除第一次出现的 attrVal，大于被移除值的索引处的属性值朝列表头方向上移（并将其索引减一）。

相等性由实现确定，其可能使用 Object.equals() 或模式信息来确定相等性。

参数：

attrval - 要从此属性中移除的可能为 null 的值。如果为 null，则移除为 null 的属性值。

返回：

如果移除了值，则返回 true；否则返回 false。

clear

void clear()

从此属性移除所有值。

getAttributeSyntaxDefinition

DirContext getAttributeSyntaxDefinition()
                                        throws NamingException

检索与属性关联的语法定义。属性的语法定义指定属性值的格式。注意，这与作为 Java 对象的属性值的表示形式不同。语法定义指的是目录的语法 概念。

例如，即使值可能为 Java String 对象，其目录语法仍可能为 "Printable String" 或 "Telephone Number"。或者值可能为字节数组，而其目录语法为 "JPEG" 或 "Certificate"。例如，如果此属性的语法为 "JPEG"，则此方法将返回 "JPEG" 的语法定义。

可以从语法定义检索的信息与目录有关。

如果实现不支持模式，则其将抛出 OperationNotSupportedException。如果实现支持模式，则其应定义此方法以返回适当的信息。

返回：

属性的语法定义。如果实现支持模式但此特定属性不具有任何模式信息，则返回 null。

抛出：

OperationNotSupportedException - 如果不支持获取模式。

NamingException - 如果在获取模式时发生命名异常。

getAttributeDefinition

DirContext getAttributeDefinition()
                                  throws NamingException

检索属性的模式定义。属性的模式定义包含的信息有：属性是多值的还是单值的；比较属性值时使用哪些匹配规则，等等。 可以从属性定义检索的信息与目录有关。

如果实现不支持模式，则其将抛出 OperationNotSupportedException。如果实现支持模式，则其应定义此方法以返回适当的信息。

返回：

此属性的模式定义。如果实现支持模式但此特定属性不具有任何模式信息，则返回 null。

抛出：

OperationNotSupportedException - 如果不支持获取模式。

NamingException - 如果在获取模式时发生命名异常。

clone

Object clone()

对属性进行复制。副本包含与初始属性相同的属性值：这些属性值不是其本身的克隆。对副本的更改不会影响原件，反之亦然。

返回：

属性的非 null 副本。

isOrdered

boolean isOrdered()

确定此属性的值是否是有序的。如果属性值是有序的，则允许重复的值。如果属性值是无序的，则它们以任意顺序出现，没有重复值。

返回：

如果此属性的值是有序的，则返回 true；否则返回 false。

另请参见：

get(int), remove(int), add(int, java.lang.Object), set(int, java.lang.Object)

get

Object get(int ix)
           throws NamingException

从属性值的有序列表中检索属性值。此方法返回属性值列表中 ix 索引处的值。如果属性值是无序的，则此方法返回正好位于该索引处的值。

参数：

ix - 属性值的有序列表中值的索引。0 <= ix < size()。

返回：

位于索引 ix 处的可能为 null 的属性值；如果属性值为 null，则返回 null。

抛出：

NamingException - 如果检索值时遇到命名异常。

IndexOutOfBoundsException - 如果 ix 位于指定范围之外。

remove

Object remove(int ix)

从属性值的有序列表中移除属性值。此方法移除属性值列表中 ix 索引处的值。如果属性值是无序的，则此方法移除正好位于该索引处的值。位于大于 ix 的索引处的值朝列表开头上移（并且其索引减一）。

参数：

ix - 要移除的值的索引。0 <= ix < size()。

返回：

已移除的位于索引 ix 处的可能为 null 的属性值；如果属性值为 null，则返回 null。

抛出：

IndexOutOfBoundsException - 如果 ix 位于指定范围之外。

add

void add(int ix,
         Object attrVal)

将属性值添加到属性值的有序列表中。此方法将 attrVal 添加到属性值列表的索引 ix 处。位于 ix 处的索引的值或大于该处的索引的值朝列表的末尾下移（并且其索引加一）。如果属性值是无序的并且已经具有 attrVal，则抛出 IllegalStateException。

参数：

ix - 要添加新值的属性值的有序列表中的索引。0 <= ix <= size()。

attrVal - 要添加的可能为 null 的属性值；如果为 null，则 null 即为添加的值。

抛出：

IndexOutOfBoundsException - 如果 ix 位于指定范围之外。

IllegalStateException - 如果属性值是无序的并且 attrVal 是这些值之一。

set

Object set(int ix,
           Object attrVal)

设置属性值的有序列表中的属性值。此方法将属性值列表中 ix 索引处的值设置为 attrVal。移除旧值。如果属性值是无序的，则此方法将正好位于该索引处的值设置为 attrVal，除非 attrVal 已经是这些值中的一个。若其已经是这些值中的一个，则抛出 IllegalStateException。

参数：

ix - 属性值的有序列表中值的索引。0 <= ix < size()。

attrVal - 要使用的可能为 null 的属性值。如果为 null，则 'null' 将替换旧值。

返回：

已替换的索引 ix 处的可能为 null 的属性值。如果属性值已为 null，则返回 null。

抛出：

IndexOutOfBoundsException - 如果 ix 位于指定范围之外。

IllegalStateException - 如果 attrVal 已存在并且属性值是无序的。