|
JNDI 1.1.1 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface represents an attribute associated with a named object.
In a directory, named objects can have associated with them attributes. The Attribute interface represents an attribute associated with a named object. An attribute contains 0 or more values. The values are unordered, with no duplicates, and can be null.
The content and representation of an attribute and its values is defined by the attribute's schema. The schema contains information about the attribute's syntax and other properties about the attribute. See getAttributeDefinition() and getAttributeSyntaxDefinition() for details regarding how to get schema information about an attribute if the underlying directory service supports schemas.
Equality of two attributes is determined by the implementation class. A simple implementation can use Object.equals() to determine equality of attribute values, while a more sophisticated implementation might make use of schema information to determine equality. Similarly, one implementation might provide a static storage structure which simply returns the values passed to its constructor, while another implementation might define get() and getAll() to get the values dynamically from the directory.
Note that updates to Attribute (such as adding or removing a value) does not affect the corresponding representation of the attribute in the directory. Updates to the directory can only be effected using operations in the DirContext interface.
BasicAttribute
Fields inherited from class java.io.Serializable |
serialVersionUID |
Method Summary | |
boolean |
add(java.lang.Object attrVal)
Adds a new value to the attribute. |
void |
clear()
Removes all values from this attribute. |
java.lang.Object |
clone()
Makes a copy of the attribute. |
boolean |
contains(java.lang.Object attrVal)
Determines whether a value is in the attribute. |
java.lang.Object |
get()
Retrieves one of this attribute's values. |
NamingEnumeration |
getAll()
Retrieves an enumeration of the attribute's values. |
DirContext |
getAttributeDefinition()
Retrieves the attribute's schema definition. |
DirContext |
getAttributeSyntaxDefinition()
Retrieves the syntax definition associated with the attribute. |
java.lang.String |
getID()
Retrieves the id of this attribute. |
boolean |
remove(java.lang.Object attrval)
Removes a specified value from the attribute. |
int |
size()
Retrieves the number of values in this attribute. |
Method Detail |
public NamingEnumeration getAll() throws NamingException
public java.lang.Object get() throws NamingException
public int size()
public java.lang.String getID()
public boolean contains(java.lang.Object attrVal)
attrVal
- The possibly null value to check. If null, check
whether the attribute has an attribute value whose value is null.Object.equals(java.lang.Object)
,
BasicAttribute.equals(java.lang.Object)
public boolean add(java.lang.Object attrVal)
Equality is determined by the implementation, which may use Object.equals() or schema information to determine equality.
attrVal
- The new possibly null value to add. If null, null
is added as an attribute value.public boolean remove(java.lang.Object attrval)
Equality is determined by the implementation, which may use Object.equals() or schema information to determine equality.
attrVal
- The possibly null value to remove from this attribute.
If null, remove the attribute value that is null.public void clear()
public DirContext getAttributeSyntaxDefinition() throws NamingException
For example, even though a value might be a Java String object, its directory syntax might be "Printable String" or "Telephone Number". Or a value might be a byte array, and its directory syntax is "JPEG" or "Certificate". For example, if this attribute's syntax is "JPEG", this method would return the syntax definition for "JPEG".
The information that you can retrieve from a syntax definition is directory-dependent.
If an implementation does not support schemas, it should throw OperationNotSupportedException. If an implementation does support schemas, it should define this method to return the appropriate information.
public DirContext getAttributeDefinition() throws NamingException
If an implementation does not support schemas, it should throw OperationNotSupportedException. If an implementation does support schemas, it should define this method to return the appropriate information.
public java.lang.Object clone()
|
JNDI 1.1.1 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |