|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--javax.naming.directory.BasicAttribute
This class provides a basic implementation of the Attribute interface.
This implementation does not support the schema methods getAttributeDefinition() and getAttributeSyntaxDefinition(). They simply throw OperationNotSupportedException. Subclasses of BasicAttribute should override these methods if they support them.
The BasicAttribute class by default uses Object.equals() to determine equality of attribute values when testing for equality or when searching for values, except when the value is an array. For an array, each element of the array is checked using Object.equals(). Subclasses of BasicAttribute can make use of schema information when doing similar equality checks by overriding methods in which such use of schema is meaningful. Similarly, the BasicAttribute class by default returns the values passed to its constructor and/or manipulated using the add/remove methods. Subclasses of BasicAttribute can override get() and getAll() to get the values dynamically from the directory (or implement the Attribute interface directly instead of subclassing BasicAttribute).
Note that updates to BasicAttribute (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.
A BasicAttribute instance is not synchronized against concurrent multithreaded access. Multiple threads trying to access and modify a BasicAttribute should lock the object.
Field Summary | |
protected java.lang.String |
attrID
Holds the attribute's id. |
protected boolean |
ordered
A flag for recording whether this attribute's values are ordered. |
protected java.util.Vector |
values
Holds the attribute's values. |
Fields inherited from interface javax.naming.directory.Attribute |
serialVersionUID |
Constructor Summary | |
BasicAttribute(java.lang.String id)
Constructs a new instance of an unordered attribute with no value. |
|
BasicAttribute(java.lang.String id,
boolean ordered)
Constructs a new instance of a possibly ordered attribute with no value. |
|
BasicAttribute(java.lang.String id,
java.lang.Object value)
Constructs a new instance of an unordered attribute with a single value. |
|
BasicAttribute(java.lang.String id,
java.lang.Object value,
boolean ordered)
Constructs a new instance of a possibly ordered attribute with a single value. |
Method Summary | |
void |
add(int ix,
java.lang.Object attrVal)
Adds an attribute value to the ordered list of attribute values. |
boolean |
add(java.lang.Object attrVal)
Adds a new value to this 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 this attribute. |
boolean |
equals(java.lang.Object obj)
Determines whether obj is equal to this attribute. |
java.lang.Object |
get()
Retrieves one of this attribute's values. |
java.lang.Object |
get(int ix)
Retrieves the attribute value from the ordered list of attribute values. |
NamingEnumeration |
getAll()
Retrieves an enumeration of this attribute's values. |
DirContext |
getAttributeDefinition()
Retrieves this attribute's schema definition. |
DirContext |
getAttributeSyntaxDefinition()
Retrieves the syntax definition associated with this attribute. |
java.lang.String |
getID()
Retrieves the id of this attribute. |
int |
hashCode()
Calculates the hash code of this attribute. |
boolean |
isOrdered()
Determines whether this attribute's values are ordered. |
java.lang.Object |
remove(int ix)
Removes an attribute value from the ordered list of attribute values. |
boolean |
remove(java.lang.Object attrval)
Removes a specified value from this attribute. |
java.lang.Object |
set(int ix,
java.lang.Object attrVal)
Sets an attribute value in the ordered list of attribute values. |
int |
size()
Retrieves the number of values in this attribute. |
java.lang.String |
toString()
Generates the string representation of this attribute. |
Methods inherited from class java.lang.Object |
finalize,
getClass,
notify,
notifyAll,
wait,
wait,
wait |
Field Detail |
protected java.lang.String attrID
protected transient java.util.Vector values
protected boolean ordered
Constructor Detail |
public BasicAttribute(java.lang.String id)
id
- The attribute's id. It cannot be null.public BasicAttribute(java.lang.String id, java.lang.Object value)
id
- The attribute's id. It cannot be null.value
- The attribute's value. If null, a null
value is added to the attribute.public BasicAttribute(java.lang.String id, boolean ordered)
id
- The attribute's id. It cannot be null.ordered
- true means the attribute's values will be ordered;
false otherwise.public BasicAttribute(java.lang.String id, java.lang.Object value, boolean ordered)
id
- The attribute's id. It cannot be null.value
- The attribute's value. If null, a null
value is added to the attribute.ordered
- true means the attribute's values will be ordered;
false otherwise.Method Detail |
public java.lang.Object clone()
public boolean equals(java.lang.Object obj)
By default Object.equals() is used when comparing the attribute id and its values except when a value is an array. For an array, each element of the array is checked using Object.equals(). A subclass may override this to make use of schema syntax information and matching rules, which define what it means for two attributes to be equal. How and whether a subclass makes use of the schema information is determined by the subclass. If a subclass overrides equals(), it should also override hashCode() such that two attributes that are equal have the same hash code.
obj
- The possibly null object to check.hashCode()
,
contains(java.lang.Object)
public int hashCode()
The hash code is computed by adding the hash code of the attribute's id and that of all of its values except for values that are arrays. For an array, the hash code of each element of the array is summed. If a subclass overrides hashCode(), it should override equals() as well so that two attributes that are equal have the same hash code.
equals(java.lang.Object)
public java.lang.String toString()
public NamingEnumeration getAll() throws NamingException
By default, the values returned are those passed to the constructor and/or manipulated using the add/replace/remove methods. A subclass may override this to retrieve the values dynamically from the directory.
Attribute.isOrdered()
public java.lang.Object get() throws NamingException
By default, the value returned is one of those passed to the constructor and/or manipulated using the add/replace/remove methods. A subclass may override this to retrieve the value dynamically from the directory.
public int size()
public java.lang.String getID()
public boolean contains(java.lang.Object attrVal)
By default, Object.equals() is used when comparing attrVal with this attribute's values except when attrVal is an array. For an array, each element of the array is checked using Object.equals(). A subclass may use schema information to determine equality.
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)
,
equals(java.lang.Object)
public boolean add(java.lang.Object attrVal)
By default, Object.equals() is used when comparing attrVal with this attribute's values except when attrVal is an array. For an array, each element of the array is checked using Object.equals(). A subclass may use 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)
By default, Object.equals() is used when comparing attrVal with this attribute's values except when attrVal is an array. For an array, each element of the array is checked using Object.equals(). A subclass may use 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 boolean isOrdered()
Attribute.get(int)
,
Attribute.remove(int)
,
Attribute.add(int, java.lang.Object)
,
Attribute.set(int, java.lang.Object)
public java.lang.Object get(int ix) throws NamingException
ix
- The index of the value in the ordered list of attribute values.
0 <= ix < size().public java.lang.Object remove(int ix)
ix
- The index of the value to remove.
0 <= ix < size().public void add(int ix, java.lang.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 java.lang.Object set(int ix, java.lang.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 DirContext getAttributeSyntaxDefinition() throws NamingException
This method by default throws OperationNotSupportedException. A subclass should override this method if it supports schema.
public DirContext getAttributeDefinition() throws NamingException
This method by default throws OperationNotSupportedException. A subclass should override this method if it supports schema.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |