| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Attributes attrs = …;
Attribute attr = attrs.get("objectClass");
Based on 71 examples
Attribute objclass = new BasicAttribute("objectclass");
Based on 51 examples
public interface Attribute extends Serializable
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, possibly null, values. The attribute values can be ordered or unordered (see isOrdered()). If the values are unordered, no duplicates are allowed. If the values are ordered, duplicates are allowed.
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) do 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.
Field Summary | |
---|---|
static long |
serialVersionUID
Use serialVersionUID from JNDI 1.1.1 for interoperability. |
Method Summary | |
---|---|
void |
Adds an attribute value to the ordered list of attribute values. |
boolean |
Adds a new value to the attribute. |
void |
clear() Removes all values from this attribute. |
Object |
clone() Makes a copy of the attribute. |
boolean |
Determines whether a value is in the attribute. |
Object |
get() Retrieves one of this attribute's values. |
Object |
get(int ix) Retrieves the attribute value from the ordered list of attribute values. |
NamingEnumeration |
getAll() Retrieves an enumeration of the attribute's values. |
DirContext |
Retrieves the attribute's schema definition. |
DirContext |
Retrieves the syntax definition associated with the attribute. |
String |
getID() Retrieves the id of this attribute. |
boolean |
Determines whether this attribute's values are ordered. |
Object |
remove(int ix) Removes an attribute value from the ordered list of attribute values. |
boolean |
Removes a specified value from the attribute. |
Object |
Sets an attribute value in the ordered list of attribute values. |
int |
size() Retrieves the number of values in this attribute. |
Field Detail |
---|
public static final long serialVersionUID
Method Detail |
---|
public void add(int ix, Object attrVal)
ix
- The index in the ordered list of attribute values to add the new value.
0 <= ix <= size().attrVal
- The possibly null attribute value to add; if null, null is
the value added.public boolean add(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 void clear()
public Object clone()
public boolean contains(Object attrVal)
attrVal
- The possibly null value to check. If null, check
whether the attribute has an attribute value whose value is null.public Object get() throws NamingException
NamingException
- If a naming exception was encountered while retrieving
the value.public Object get(int ix) throws NamingException
ix
- The index of the value in the ordered list of attribute values.
0 <= ix < size().NamingException
- If a naming exception was encountered while
retrieving the value.public NamingEnumeration getAll() throws NamingException
NamingException
- If a naming exception was encountered while retrieving
the values.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.
NamingException
- If a naming exception occurs while getting
the schema.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.
NamingException
- If a naming exception occurs while getting
the schema.public String getID()
public boolean isOrdered()
public Object remove(int ix)
ix
- The index of the value to remove.
0 <= ix < size().public boolean remove(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 Object set(int ix, Object attrVal)
ix
- The index of the value in the ordered list of attribute values.
0 <= ix < size().attrVal
- The possibly null attribute value to use.
If null, 'null' replaces the old value.public int size()
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |