| |
|
| javax.naming.directory.Attributes
All known Subclasses: javax.naming.directory.BasicAttributes,
| Attributes | | public interface Attributes extends Cloneable,java.io.Serializable(Code) | | 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.
author:
Rosanna Lee
author:
Scott Seligman
version:
1.17 07/05/05
See Also: DirContext.getAttributes
See Also: DirContext.modifyAttributes
See Also: DirContext.bind
See Also: DirContext.rebind
See Also: DirContext.createSubcontext
See Also: DirContext.search
See Also: BasicAttributes
since:
1.3 |
| Method Summary | |
| Object | clone()
Makes a copy of the attribute set. | | Attribute | get(String attrID)
Retrieves the attribute with the given attribute id from the
attribute set.
Parameters:
attrID - The non-null id of the attribute to retrieve.If this attribute set ignores the charactercase of its attribute ids, the case of attrIDis ignored. | | NamingEnumeration<? extends Attribute> | getAll()
Retrieves an enumeration of the attributes in the attribute set. | | 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.
A non-null enumeration of the attributes' ids inthis attribute set. | | boolean | isCaseIgnored()
Determines whether the attribute set ignores the case of
attribute identifiers when retrieving or adding attributes. | | Attribute | put(String attrID, Object val)
Adds a new attribute to the attribute set.
Parameters:
attrID - non-null The id of the attribute to add.If the attribute set ignores the charactercase of its attribute ids, the case of attrIDis ignored.
Parameters:
val - The possibly null value of the attribute to add.If null, the attribute does not have any values. | | Attribute | put(Attribute attr)
Adds a new attribute to the attribute set.
Parameters:
attr - The non-null attribute to add.If the attribute set ignores the charactercase of its attribute ids, the case ofattr's identifier is ignored. | | Attribute | remove(String attrID)
Removes the attribute with the attribute id 'attrID' from
the attribute set. | | int | size()
Retrieves the number of attributes in the attribute set. |
| clone | | Object clone()(Code) | | 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.
A non-null copy of this attribute set. |
| get | | Attribute get(String attrID)(Code) | | Retrieves the attribute with the given attribute id from the
attribute set.
Parameters:
attrID - The non-null id of the attribute to retrieve.If this attribute set ignores the charactercase of its attribute ids, the case of attrIDis ignored. The attribute identified by attrID; null if not found.
See Also: Attributes.put
See Also: Attributes.remove |
| getAll | | NamingEnumeration<? extends Attribute> getAll()(Code) | | Retrieves an enumeration of the attributes in the attribute set.
The effects of updates to this attribute set on this enumeration
are undefined.
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. |
| getIDs | | NamingEnumeration<String> getIDs()(Code) | | 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.
A non-null enumeration of the attributes' ids inthis attribute set. Each element of the enumeration isof class String.If attribute set has zero attributes, an empty enumeration is returned. |
| isCaseIgnored | | boolean isCaseIgnored()(Code) | | Determines whether the attribute set ignores the case of
attribute identifiers when retrieving or adding attributes.
true if case is ignored; false otherwise. |
| put | | Attribute put(String attrID, Object val)(Code) | | Adds a new attribute to the attribute set.
Parameters:
attrID - non-null The id of the attribute to add.If the attribute set ignores the charactercase of its attribute ids, the case of attrIDis ignored.
Parameters:
val - The possibly null value of the attribute to add.If null, the attribute does not have any values. The Attribute with attrID that was previous in this attribute set;null if no such attribute existed.
See Also: Attributes.remove |
| put | | Attribute put(Attribute attr)(Code) | | Adds a new attribute to the attribute set.
Parameters:
attr - The non-null attribute to add.If the attribute set ignores the charactercase of its attribute ids, the case ofattr's identifier is ignored. The Attribute with the same ID as attr that was previous in this attribute set;null if no such attribute existed.
See Also: Attributes.remove |
| remove | | Attribute remove(String attrID)(Code) | | Removes the attribute with the attribute id 'attrID' from
the attribute set. If the attribute does not exist, ignore.
Parameters:
attrID - The non-null id of the attribute to remove.If the attribute set ignores the charactercase of its attribute ids, the case of attrID is ignored. The Attribute with the same ID as attrID that was previous in the attribute set;null if no such attribute existed. |
| size | | int size()(Code) | | Retrieves the number of attributes in the attribute set.
The nonnegative number of attributes in this attribute set. |
|
|
|