|
Java™ Platform Standard Ed. 6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Attributes
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.
DirContext.getAttributes(javax.naming.Name)
,
DirContext.modifyAttributes(javax.naming.Name, int, javax.naming.directory.Attributes)
,
DirContext.bind(javax.naming.Name, java.lang.Object, javax.naming.directory.Attributes)
,
DirContext.rebind(javax.naming.Name, java.lang.Object, javax.naming.directory.Attributes)
,
DirContext.createSubcontext(javax.naming.Name, javax.naming.directory.Attributes)
,
DirContext.search(javax.naming.Name, javax.naming.directory.Attributes, java.lang.String[])
,
BasicAttributes
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. |
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. |
boolean |
isCaseIgnored()
Determines whether the attribute set ignores the case of attribute identifiers when retrieving or adding attributes. |
Attribute |
put(Attribute attr)
Adds a new attribute to the attribute set. |
Attribute |
put(String attrID,
Object val)
Adds a new attribute to the attribute set. |
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. |
Method Detail |
---|
boolean isCaseIgnored()
int size()
Attribute get(String attrID)
attrID
- 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.
put(java.lang.String, java.lang.Object)
,
remove(java.lang.String)
NamingEnumeration<? extends Attribute> getAll()
NamingEnumeration<String> getIDs()
Attribute put(String attrID, Object val)
attrID
- 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
- The possibly null value of the attribute to add.
If null, the attribute does not have any values.
remove(java.lang.String)
Attribute put(Attribute attr)
attr
- 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.
remove(java.lang.String)
Attribute remove(String attrID)
attrID
- 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.
Object clone()
|
Java™ Platform Standard Ed. 6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 1993, 2015, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
Scripting on this page tracks web page traffic, but does not change the content in any way.