APIdia Launch Partner
Top Description Methods
javax.naming.directory

public Interface Attributes

extends Cloneable, Serializable
Known Direct Implementers
javax.naming.directory.BasicAttributes
Imports
java.util.Hashtable, .Enumeration, javax.naming.NamingException, .NamingEnumeration
This interface represents a collection of attributes.

In a directory, named objects can have associated with them attributes. The Attributes interface represents a collection of attributes. For example, you can request from the directory the attributes associated with an object. Those attributes are returned in an object that implements the Attributes interface.

Attributes in an object that implements the Attributes interface are unordered. The object can have zero or more attributes. Attributes is either case-sensitive or case-insensitive (case-ignore). This property is determined at the time the Attributes object is created. (see BasicAttributes constructor for example). In a case-insensitive Attributes, the case of its attribute identifiers is ignored when searching for an attribute, or adding attributes. In a case-sensitive Attributes, the case is significant.

Note that updates to Attributes (such as adding or removing an attribute) do not affect the corresponding representation in the directory. Updates to the directory can only be effected using operations in the DirContext interface.

Authors
Rosanna Lee, Scott Seligman
Since
1.3
See Also
DirContext#getAttributes, DirContext#modifyAttributes, DirContext#bind, DirContext#rebind, DirContext#createSubcontext, DirContext#search, BasicAttributes

Method Summary

Modifier and TypeMethod and Description
public Object

Returns:

A non-null copy of this attribute set.
clone()

Makes a copy of the attribute set.

public Attribute

Returns:

The attribute identified by attrID; null if not found.
get(String
The non-null id of the attribute to retrieve. If this attribute set ignores the character case of its attribute ids, the case of attrID is ignored.
attrID)

Retrieves the attribute with the given attribute id from the attribute set.

public NamingEnumeration<? extends Attribute>

Returns:

A non-null enumeration of the attributes in this attribute set. Each element of the enumeration is of class Attribute. If attribute set has zero attributes, an empty enumeration is returned.
getAll()

Retrieves an enumeration of the attributes in the attribute set.

public NamingEnumeration<String>

Returns:

A non-null enumeration of the attributes' ids in this attribute set. Each element of the enumeration is of class String. If attribute set has zero attributes, an empty enumeration is returned.
getIDs()

Retrieves an enumeration of the ids of the attributes in the attribute set.

public boolean

Returns:

true if case is ignored; false otherwise.
isCaseIgnored()

Determines whether the attribute set ignores the case of attribute identifiers when retrieving or adding attributes.

public Attribute

Returns:

The Attribute with attrID that was previous in this attribute set; null if no such attribute existed.
put(String
non-null The id of the attribute to add. If the attribute set ignores the character case of its attribute ids, the case of attrID is ignored.
attrID, Object
The possibly null value of the attribute to add. If null, the attribute does not have any values.
val)

Adds a new attribute to the attribute set.

public Attribute

Returns:

The Attribute with the same ID as attr that was previous in this attribute set; null if no such attribute existed.
put(Attribute
The non-null attribute to add. If the attribute set ignores the character case of its attribute ids, the case of attr's identifier is ignored.
attr)

Adds a new attribute to the attribute set.

public Attribute

Returns:

The Attribute with the same ID as attrID that was previous in the attribute set; null if no such attribute existed.
remove(String
The non-null id of the attribute to remove. If the attribute set ignores the character case of its attribute ids, the case of attrID is ignored.
attrID)

Removes the attribute with the attribute id 'attrID' from the attribute set.

public int

Returns:

The nonnegative number of attributes in this attribute set.
size()

Retrieves the number of attributes in the attribute set.

Method Detail

cloneback to summary
public Object clone()

Makes a copy of the attribute set. The new set contains the same attributes as the original set: the attributes are not themselves cloned. Changes to the copy will not affect the original and vice versa.

Returns:Object

A non-null copy of this attribute set.

getback to summary
public Attribute get(String attrID)

Retrieves the attribute with the given attribute id from the attribute set.

Parameters
attrID:String

The non-null id of the attribute to retrieve. If this attribute set ignores the character case of its attribute ids, the case of attrID is ignored.

Returns:Attribute

The attribute identified by attrID; null if not found.

See Also
put, remove
getAllback to summary
public NamingEnumeration<? extends Attribute> getAll()

Retrieves an enumeration of the attributes in the attribute set. The effects of updates to this attribute set on this enumeration are undefined.

Returns:NamingEnumeration<? extends Attribute>

A non-null enumeration of the attributes in this attribute set. Each element of the enumeration is of class Attribute. If attribute set has zero attributes, an empty enumeration is returned.

getIDsback to summary
public NamingEnumeration<String> getIDs()

Retrieves an enumeration of the ids of the attributes in the attribute set. The effects of updates to this attribute set on this enumeration are undefined.

Returns:NamingEnumeration<String>

A non-null enumeration of the attributes' ids in this attribute set. Each element of the enumeration is of class String. If attribute set has zero attributes, an empty enumeration is returned.

isCaseIgnoredback to summary
public boolean isCaseIgnored()

Determines whether the attribute set ignores the case of attribute identifiers when retrieving or adding attributes.

Returns:boolean

true if case is ignored; false otherwise.

putback to summary
public Attribute put(String attrID, Object val)

Adds a new attribute to the attribute set.

Parameters
attrID:String

non-null The id of the attribute to add. If the attribute set ignores the character case of its attribute ids, the case of attrID is ignored.

val:Object

The possibly null value of the attribute to add. If null, the attribute does not have any values.

Returns:Attribute

The Attribute with attrID that was previous in this attribute set; null if no such attribute existed.

See Also
remove
putback to summary
public Attribute put(Attribute attr)

Adds a new attribute to the attribute set.

Parameters
attr:Attribute

The non-null attribute to add. If the attribute set ignores the character case of its attribute ids, the case of attr's identifier is ignored.

Returns:Attribute

The Attribute with the same ID as attr that was previous in this attribute set; null if no such attribute existed.

See Also
remove
removeback to summary
public Attribute remove(String attrID)

Removes the attribute with the attribute id 'attrID' from the attribute set. If the attribute does not exist, ignore.

Parameters
attrID:String

The non-null id of the attribute to remove. If the attribute set ignores the character case of its attribute ids, the case of attrID is ignored.

Returns:Attribute

The Attribute with the same ID as attrID that was previous in the attribute set; null if no such attribute existed.

sizeback to summary
public int size()

Retrieves the number of attributes in the attribute set.

Returns:int

The nonnegative number of attributes in this attribute set.