BasicAttribute (Java Platform SE 8 )

java.lang.Object
- javax.naming.directory.BasicAttribute

All Implemented Interfaces:

Serializable， Cloneable， Attribute
```
public class BasicAttribute
extends Object
implements Attribute
```
这个类提供了 Attribute接口的基本实现。
此实现不支持模式方法getAttributeDefinition()和getAttributeSyntaxDefinition()。他们只是把OperationNotSupportedException。子BasicAttribute应该重写这些方法，如果他们支持他们。

默认情况下，BasicAttribute类使用Object.equals()确定属性值相等时测试相等或在寻找价值，但价值是一个数组。对于一个数组，数组的每个元素是检查使用Object.equals()。子BasicAttribute可以利用架构信息时做类似的等式进行重写方法在其中使用模式是有意义的。同样，默认情况下，BasicAttribute类返回值传递给其构造函数和/或操纵使用添加/删除方法。子类可以重写BasicAttribute get()和getAll()动态地从目录中获取的值（或实施Attribute接口直接代替子BasicAttribute）。

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

一个BasicAttribute实例不同步的并发多线程访问。多个线程试图访问和修改BasicAttribute应该锁定对象。

从以下版本开始：

一点三

另请参见：

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`attrID` 保存属性的标识。
`protected boolean`	`ordered` 记录此属性的值是否有序的标志。
`protected Vector<Object>`	`values` 保存属性的值。

构造方法摘要

构造方法
Constructor and Description
`BasicAttribute(String id)` 构建一个没有价值的无序属性的一个新实例。
`BasicAttribute(String id, boolean ordered)` 构造一个可能有没有值的有序属性的新实例。
`BasicAttribute(String id, Object value)` 构建一个单一的价值无序属性的一个新实例。
`BasicAttribute(String id, Object value, boolean ordered)` 构造一个可能具有单个值的可能有序属性的新实例。

方法摘要

所有方法接口方法具体的方法
Modifier and Type	Method and Description
`void`	`add(int ix, Object attrVal)` 将属性值添加到属性值的有序列表中。
`boolean`	`add(Object attrVal)` 向此属性添加一个新值。
`void`	`clear()` 从这个属性中移除所有的值。
`Object`	`clone()` 创建并返回此对象的副本。
`boolean`	`contains(Object attrVal)` 确定一个值是否在这个属性中。
`boolean`	`equals(Object obj)` 确定目标等于该属性。
`Object`	`get()` 检索此属性的值的一个。
`Object`	`get(int ix)` 从属性值的有序列表中检索属性值。
`NamingEnumeration<?>`	`getAll()` 检索此属性的值的枚举。
`DirContext`	`getAttributeDefinition()` 检索此属性的架构定义。
`DirContext`	`getAttributeSyntaxDefinition()` 检索与此属性关联的语法定义。
`String`	`getID()` 检索此属性的标识。
`int`	`hashCode()` 计算此属性的哈希代码。
`boolean`	`isOrdered()` 确定此属性的值是否有序。
`Object`	`remove(int ix)` 从属性值的有序列表中移除属性值。
`boolean`	`remove(Object attrval)` 从这个属性中移除指定的值。
`Object`	`set(int ix, Object attrVal)` 在属性值的有序列表中设置一个属性值。
`int`	`size()` 检索此属性中的值的数目。
`String`	`toString()` 生成此属性的字符串表示形式。

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - attrID
```
protected String attrID
```
    拥有属性的ID，它是由公共构造函数初始化为空，除非不在BasicAttribute使用attrid被重写的方法。
  - values
```
protected transient Vector<Object> values
```
    保存属性的值。由公共构造函数初始化。不能为空，除非在BasicAttribute使用的值已被重写的方法。
  - ordered
```
protected boolean ordered
```
    记录此属性的值是否有序的标志。
- Constructor Detail
  - BasicAttribute
```
public BasicAttribute(String id)
```
    构建一个没有价值的无序属性的一个新实例。
    
    参数
    
    id -属性的ID，它不能为空。
  - BasicAttribute
```
public BasicAttribute(String id,
                      Object value)
```
    构建一个单一的价值无序属性的一个新实例。
    
    参数
    
    id -属性的ID，它不能为空。
    
    value -属性的值。如果为空，则将一个空值添加到属性中。
  - BasicAttribute
```
public BasicAttribute(String id,
                      boolean ordered)
```
    构造一个可能有没有值的有序属性的新实例。
    
    参数
    
    id -属性的ID，它不能为空。
    
    ordered -真的意味着属性的值将被命令；否则为false。
  - BasicAttribute
```
public BasicAttribute(String id,
                      Object value,
                      boolean ordered)
```
    构造一个可能具有单个值的可能有序属性的新实例。
    
    参数
    
    id -属性的ID，它不能为空。
    
    value -属性的值。如果为空，则将一个空值添加到属性中。
    
    ordered -真的意味着属性的值将被命令；否则为false。
- 方法详细信息
  - clone
```
public Object clone()
```
    从阶级复制的描述： Object
    创建并返回此对象的副本。“复制”的确切含义可能取决于对象的类。这样做的目的是，对于任何对象 x，表达：
    x.clone() != x
    将是真实的，并表示：
    x.clone().getClass() == x.getClass()
    将 true，但这些都不是绝对的要求。虽然这是通常的情况下，
    x.clone().equals(x)
    将 true，这不是一个绝对的要求。
    按照惯例，返回的对象应该通过调用super.clone得到。如果一个类和它的所有父类（除Object）遵守本公约的情况下，这将是x.clone().getClass() == x.getClass()。
    
    根据惯例，这个方法返回的对象应该是独立于这个对象（正在被克隆）。为了实现这种独立性，需要修改的super.clone返回对象的一个或多个字段然后返回。通常，这意味着复制任何可变对象，包括内部的“深层结构”被克隆对象的更换与该份对这些对象的引用的参考文献。如果一个类只包含原始字段或对不可变对象的引用，那么它是通常的情况下，通过super.clone返回的对象中的任何字段需要修改。
    
    类的方法Object clone执行特定的复制操作。首先，如果此对象的类不实现接口Cloneable，然后CloneNotSupportedException抛出。请注意，所有的数组都被实现的接口Cloneable，数组类型的clone T[]方法的返回类型是T[]其中T是任何参考或原始类型。否则，此方法创建此对象的类的新实例并初始化与正是这个对象的相应字段内容的各个领域，如分配；字段的内容不克隆自己。因此，该方法执行此对象的“浅副本”，而不是“深复制”操作。
    
    这类Object本身不实现接口Cloneable，所以叫clone方法对一个对象的类是Object将导致在运行时抛出异常。
    Specified by:
    
    clone 接口 Attribute
    
    重写：
    
    clone 方法重写，继承类 Object
    
    结果
    
    这个实例的克隆。
    
    另请参见：
    
    Cloneable
  - equals
```
public boolean equals(Object obj)
```
    确定目标等于该属性。如果他们的属性ID的两个属性都是平等的，语法和值相等。如果属性值是无序的，添加的值的顺序是无关紧要的。如果属性值是有序的，那么该值必须匹配的顺序。如果obj为空或不是一个属性，则返回FALSE。
    默认情况下Object.equals()是用于比较的属性ID和它的价值除了当一个值的数组。对于一个数组，数组的每个元素都是使用Object.equals()检查。一个子类可以重写此来使用架构语法信息和匹配规则，它定义了两个属性是相等的两个属性的方法。如何以及子类是否利用架构信息由子类决定的。如果子类重写equals()，它也应该重写hashCode()这样两个属性，同样具有相同的哈希代码。
    
    重写：
    
    equals 方法重写，继承类 Object
    
    参数
    
    obj -检查可能的空对象。
    
    结果
    
    如果obj等于这个属性真；否则为false。
    
    另请参见：
    
    hashCode()， contains(java.lang.Object)
  - hashCode
```
public int hashCode()
```
    计算此属性的哈希代码。
    哈希代码计算通过添加属性的身份证的哈希代码和它的所有值，除了数组的值。对于一个数组，可以求出数组中每个元素的哈希代码。如果子类重写hashCode()，它应该覆盖equals()这样两个属性，同样具有相同的哈希代码。
    
    重写：
    
    hashCode 方法重写，继承类 Object
    
    结果
    
    表示此属性的哈希代码int。
    
    另请参见：
    
    equals(java.lang.Object)
  - toString
```
public String toString()
```
    生成此属性的字符串表示形式。字符串由属性的标识和它的值组成。这个字符串是调试而不能解释程序。
    
    重写：
    
    toString 方法重写，继承类 Object
    
    结果
    
    此属性的非空字符串表示。
  - getAll
```
public NamingEnumeration<?> getAll()
                            throws NamingException
```
    检索此属性的值的枚举。
    默认情况下，返回的值是那些传递给构造函数和/或操作使用的添加/替换/删除方法。子类可以重写此，从目录中动态检索值。
    
    Specified by:
    
    getAll 接口 Attribute
    
    结果
    
    属性的值的非空枚举。枚举的每个元素都是一个可能的空对象。对象的类是属性值的类。如果属性的值为空，则该元素为空。如果属性具有0值，则返回一个空枚举。
    
    异常
    
    NamingException -如果在检索值，遇到的是一个命名的例外。
    
    另请参见：
    
    Attribute.isOrdered()
  - get
```
public Object get()
           throws NamingException
```
    检索此属性的值的一个。
    默认情况下，返回的值是传递给构造函数和/或操作使用添加/替换/删除方法的那些人之一。子类可以重写此以从目录中动态检索值。
    
    Specified by:
    
    get 接口 Attribute
    
    结果
    
    表示表示属性的值的一个的可能为空的对象。如果属性的值为空，则为空。
    
    异常
    
    NamingException -如果在检索值，遇到的是一个命名的例外。
  - size
```
public int size()
```
    从接口复制的描述： Attribute
    
    检索此属性中的值的数目。
    
    Specified by:
    
    size 接口 Attribute
    
    结果
    
    此属性中的值的非负数。
  - getID
```
public String getID()
```
    从接口复制的描述： Attribute
    
    检索此属性的标识。
    
    Specified by:
    
    getID 接口 Attribute
    
    结果
    
    此属性的标识。它不能为空。
  - contains
```
public boolean contains(Object attrVal)
```
    确定一个值是否在这个属性中。
    默认情况下，Object.equals()时使用此属性的值进行比较attrVal除了attrVal是数组。对于一个数组，数组的每个元素都是使用Object.equals()检查。子类可以使用模式信息来确定等式。
    
    Specified by:
    
    contains 接口 Attribute
    
    参数
    
    attrVal -可能的空值检查。如果为空，则检查该属性是否具有一个属性值，该属性值为空。
    
    结果
    
    如果attrval是这个属性值true；否则为false。
    
    另请参见：
    
    Object.equals(java.lang.Object)， equals(java.lang.Object)
  - add
```
public boolean add(Object attrVal)
```
    向此属性添加一个新值。
    默认情况下，Object.equals()时使用此属性的值进行比较attrVal除了attrVal是数组。对于一个数组，数组的每个元素是检查使用Object.equals()。子类可以使用模式信息来确定平等。
    
    Specified by:
    
    add 接口 Attribute
    
    参数
    
    attrVal -新的可能的空值增加。如果为空，则将空值添加为属性值。
    
    结果
    
    如果一个值被添加，则为假。
  - remove
```
public boolean remove(Object attrval)
```
    从这个属性中移除指定的值。
    默认情况下，Object.equals()时使用此属性的值进行比较attrVal除了attrVal是数组。对于一个数组，数组的每个元素都是使用Object.equals()检查。子类可以使用模式信息来确定等式。
    
    Specified by:
    
    remove 接口 Attribute
    
    参数
    
    attrval -这个属性去除可能的空值。如果为空，则删除空的属性值。
    
    结果
    
    如果值被删除，则为真；否则为。
  - clear
```
public void clear()
```
    从接口复制的描述： Attribute
    
    从这个属性中移除所有的值。
    
    Specified by:
    
    clear 接口 Attribute
  - isOrdered
```
public boolean isOrdered()
```
    从接口复制的描述： Attribute
    
    确定此属性的值是否有序。如果一个属性的值是有序的，则允许重复的值。如果属性的值是无序的，他们在任何顺序和没有重复的值。
    
    Specified by:
    
    isOrdered 接口 Attribute
    
    结果
    
    如果此属性的值是有序的，则为假；否则为。
    
    另请参见：
    
    Attribute.get(int)， Attribute.remove(int)， Attribute.add(int, java.lang.Object)， Attribute.set(int, java.lang.Object)
  - get
```
public Object get(int ix)
           throws NamingException
```
    从接口复制的描述： Attribute
    
    从属性值的有序列表中检索属性值。此方法返回的属性值的列表 ix指标值。如果属性值是无序的，这个方法返回值，恰好是在指数。
    
    Specified by:
    
    get 接口 Attribute
    
    参数
    
    ix -属性值的有序列表的值的索引。 0 <= ix < size()。
    
    结果
    
    在指数 ix可能的空属性值；如果属性值为空。
    
    异常
    
    NamingException -如果在检索值，遇到的是一个命名的例外。
  - remove
```
public Object remove(int ix)
```
    从接口复制的描述： Attribute
    
    从属性值的有序列表中移除属性值。此方法删除值在属性值的列表 ix指数。如果属性值是无序的，此方法删除值，恰好是在指数。值位于指数大于 ix移向前面的列表（和他们的指数递减一）。
    
    Specified by:
    
    remove 接口 Attribute
    
    参数
    
    ix -值删除索引。 0 <= ix < size()。
    
    结果
    
    在指数 ix被删除可能的空属性值；如果属性值为空。
  - add
```
public void add(int ix,
                Object attrVal)
```
    从接口复制的描述： Attribute
    
    将属性值添加到属性值的有序列表中。该方法将 attrVal的属性值列表索引 ix。位于指数值大于或 ix移到列表的末尾（和他们的指数递增1）。如果属性值是无序的和已经 attrVal， IllegalStateException抛出。
    
    Specified by:
    
    add 接口 Attribute
    
    参数
    
    ix -属性值的有序列表的索引来添加新的价值。 0 <= ix <= size()。
    
    attrVal -添加可能的空属性的值；如果为空，空是增值。
  - set
```
public Object set(int ix,
                  Object attrVal)
```
    从接口复制的描述： Attribute
    
    在属性值的有序列表中设置一个属性值。此方法设置值的属性值的列表 ix指数是 attrVal。旧值被删除。如果属性值是无序的，此方法设置的值，恰好是在指数 attrVal，除非 attrVal已经是一个价值观。在这种情况下， IllegalStateException抛出。
    
    Specified by:
    
    set 接口 Attribute
    
    参数
    
    ix -属性值的有序列表的值的索引。 0 <= ix < size()。
    
    attrVal -可能的空属性的使用价值。如果为空，“空”替换旧值。
    
    结果
    
    在索引IX，取而代之的是可能的空属性值。如果属性值为空的话。
  - getAttributeSyntaxDefinition
```
public DirContext getAttributeSyntaxDefinition()
                                        throws NamingException
```
    检索与此属性关联的语法定义。
    这种方法在默认情况下将operationnotsupportedexception。子类应重写此方法，如果它支持模式。
    
    Specified by:
    
    getAttributeSyntaxDefinition 接口 Attribute
    
    结果
    
    属性的语法定义。如果实现支持模式，但此特定属性没有任何模式信息。
    
    异常
    
    OperationNotSupportedException如果得到的模式是不支持的。
    
    NamingException如果发生异常而获得命名模式。
  - getAttributeDefinition
```
public DirContext getAttributeDefinition()
                                  throws NamingException
```
    检索此属性的架构定义。
    这种方法在默认情况下将operationnotsupportedexception。子类应重写此方法，如果它支持模式。
    
    Specified by:
    
    getAttributeDefinition 接口 Attribute
    
    结果
    
    此属性的架构定义。如果实现支持模式，但此特定属性没有任何模式信息。
    
    异常
    
    OperationNotSupportedException如果得到的模式是不支持的。
    
    NamingException如果发生异常而获得命名模式。

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2014, Oracle and/or its affiliates. All rights reserved.

Class BasicAttribute

Field Summary

构造方法摘要

方法摘要

Methods inherited from class java.lang.Object

Field Detail

attrID

values

ordered

Constructor Detail

BasicAttribute

BasicAttribute

BasicAttribute

BasicAttribute

方法详细信息

clone

equals

hashCode

toString

getAll

get

size

getID

contains

add

remove

clear

isOrdered

get

remove

add

set

getAttributeSyntaxDefinition

getAttributeDefinition