compact3

javax.naming.directory

Interface Attribute

All Superinterfaces:

Cloneable， Serializable

所有已知实现类：

BasicAttribute

public interface Attribute
extends Cloneable, Serializable

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

在一个目录中，命名的对象可以与它们关联的属性。的Attribute接口代表一个命名的对象相关联的属性。属性包含0个或更多，可能为空值。属性的值可以是有序或无序的（见isOrdered()）。如果值是无序的，没有重复是允许的。如果值是有序的，则允许重复。

属性和它的值的内容和表示形式由属性的模式定义。该模式包含有关属性的属性的语法和其他属性的信息。看到getAttributeDefinition()和getAttributeSyntaxDefinition()细节关于如何获得一个属性架构信息如果基础目录服务支持模式。

两个属性的相等由实现类决定。一个简单的实现可以使用Object.equals()确定属性值相等，而更复杂的实现可能会利用图式的信息来确定平等。同样的，一个可能的实现提供一个静态存储结构，只是返回传递给构造函数的值，而另一个可能的实现定义get()和getAll()。为了从目录中动态获取值。

注意更新Attribute（如添加或删除一个值）不影响该目录中的属性对应的表示。目录的更新只能在DirContext接口使用操作的影响。

从以下版本开始：

一点三

另请参见：

BasicAttribute

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID 从互操作性的serialVersionUID使用JNDI 1.1.1。

方法摘要

Modifier and Type	Method and Description
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() 检索此属性的标识。
boolean	isOrdered() 确定此属性的值是否有序。
Object	remove(int ix) 从属性值的有序列表中移除属性值。
boolean	remove(Object attrval) 从属性中移除指定的值。
Object	set(int ix, Object attrVal) 在属性值的有序列表中设置一个属性值。
int	size() 检索此属性中的值的数目。

Field Detail

serialVersionUID

static final long serialVersionUID

从互操作性的serialVersionUID使用JNDI 1.1.1。

另请参见：

Constant Field Values

方法详细信息

getAll

NamingEnumeration<?> getAll()
                     throws NamingException

检索属性的值的枚举数。此枚举的行为是未指定的，如果属性的值被添加、更改或删除，而枚举正在进行中。如果属性值是有序的，则枚举的项目将被订购。

结果

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

异常

NamingException -如果在检索值，遇到的是一个命名的例外。

另请参见：

isOrdered()

get

Object get()
    throws NamingException

检索此属性的值的一个。如果属性有多个值，是无序的，任何一个返回的值。如果属性有一个以上的值，并被命令，则返回第一个值。

结果

表示表示属性的值的一个的可能为空的对象。如果属性的值为空，则为空。

异常

NamingException -如果在检索值，遇到的是一个命名的例外。

NoSuchElementException -如果这个属性没有值。

size

int size()

检索此属性中的值的数目。

结果

此属性中的值的非负数。

getID

String getID()

检索此属性的标识。

结果

此属性的标识。它不能为空。

contains

boolean contains(Object attrVal)

确定一个值是否在属性中。平等的实现，可以使用 Object.equals()或架构信息确定平等。

参数

attrVal -可能的空值检查。如果为空，则检查该属性是否具有一个属性值，该属性值为空。

结果

如果attrval是这个属性值true；否则为false。

另请参见：

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

add

boolean add(Object attrVal)

向属性添加一个新值。如果属性值是无序的和 attrVal已经在属性，此方法不做任何事。如果属性值是有序的， attrVal添加到属性值的列表的末尾。

平等的实现，可以使用Object.equals()或架构信息确定平等。

参数

attrVal -新的可能的空值增加。如果为空，则将空值添加为属性值。

结果

如果一个值被添加，则为假。

remove

boolean remove(Object attrval)

从属性中移除指定的值。如果 attrval不是属性，这种方法不。如果属性值是有序的，第一次出现的 attrVal删除和属性值在指数大于删除值移向列表的头部（和他们的指数递减一）。

平等的实现，可以使用Object.equals()或架构信息确定平等。

参数

attrval -这个属性去除可能的空值。如果为空，则删除空的属性值。

结果

如果值被删除，则为真；否则为。

clear

void clear()

从这个属性中移除所有的值。

getAttributeSyntaxDefinition

DirContext getAttributeSyntaxDefinition()
                                 throws NamingException

检索与属性关联的语法定义。属性的语法定义指定属性值的格式（S）。请注意，这是由不同的属性值表示为一个java对象。语法定义是指目录的语法概念。

例如，即使一个值可能是一个java的字符串对象，其目录的语法可能是“字符串”或“电话号码”。或一个值可能是一个字节数组，其目录的语法是“JPEG”或“证书”。例如，如果该属性的语法是“JPEG”，此方法将返回的语法定义为“JPEG”。

从语法定义中检索的信息是依赖目录的。

如果实现不支持的模式，应把operationnotsupportedexception。如果一个实现不支持模式，它应该定义这个方法来返回适当的信息。

结果

属性的语法定义。如果实现支持模式，但此特定属性没有任何模式信息。

异常

OperationNotSupportedException如果得到的模式是不支持的。

NamingException如果发生异常而获得命名模式。

getAttributeDefinition

DirContext getAttributeDefinition()
                           throws NamingException

检索属性的架构定义。一个属性的架构定义中包含的信息，如是否属性是多值和单值，匹配规则时要使用的属性的值的比较。从属性定义中检索的信息是依赖于目录的。

如果实现不支持的模式，应把operationnotsupportedexception。如果一个实现不支持模式，它应该定义这个方法来返回适当的信息。

结果

此属性的架构定义。如果实现支持模式，但此特定属性没有任何模式信息。

异常

OperationNotSupportedException如果得到的模式是不支持的。

NamingException如果发生异常而获得命名模式。

clone

Object clone()

做一个属性的副本。副本包含相同的属性值作为原始属性：属性值不是自己克隆的。对副本的更改不会影响原始，反之亦然。

结果

属性的非空副本。

isOrdered

boolean isOrdered()

确定此属性的值是否有序。如果一个属性的值是有序的，则允许重复的值。如果属性的值是无序的，他们在任何顺序和没有重复的值。

结果

如果此属性的值是有序的，则为假；否则为。

另请参见：

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可能的空属性值；如果属性值为空。

异常

NamingException -如果在检索值，遇到的是一个命名的例外。

IndexOutOfBoundsException -如果 ix是指定范围以外。

remove

Object remove(int ix)

从属性值的有序列表中移除属性值。此方法删除值在属性值的列表 ix指数。如果属性值是无序的，此方法删除值，恰好是在指数。位于指数大于 ix移向前面的列表值（和他们的指数递减一）。

参数

ix -值删除索引。 0 <= ix < size()。

结果

在指数 ix被删除可能的空属性值；如果属性值为空。

异常

IndexOutOfBoundsException -如果 ix是指定范围以外。

add

void add(int ix,
         Object attrVal)

将属性值添加到属性值的有序列表中。该方法将 attrVal的属性值列表索引 ix。值位于指数大于或 ix移到列表的末尾（和他们的指数递增1）。如果属性值是无序的和已经 attrVal， IllegalStateException抛出。

参数

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

attrVal -添加可能的空属性的值；如果为空，空是增值。

异常

IndexOutOfBoundsException -如果 ix是指定范围以外。

IllegalStateException -如果属性值是无序的和 attrVal是其中的一个值。

set

Object set(int ix,
           Object attrVal)

在属性值的有序列表中设置一个属性值。此方法设置值的属性值的列表 ix指数是 attrVal。旧值被删除。如果属性值是无序的，此方法设置的值，恰好是在指数 attrVal，除非 attrVal已经是一个价值观。在这种情况下， IllegalStateException抛出。

参数

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

attrVal -可能的空属性的使用价值。如果为空，“空”替换旧值。

结果

在索引IX，取而代之的是可能的空属性值。如果属性值为空的话。

异常

IndexOutOfBoundsException -如果 ix是指定范围以外。

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