- All Implemented Interfaces:
Serializable
,Cloneable
,Attribute
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.
- Since:
- 1.3
- See Also:
-
Field Summary
-
Constructor Summary
ConstructorDescriptionBasicAttribute
(String id) Constructs a new instance of an unordered attribute with no value.BasicAttribute
(String id, boolean ordered) Constructs a new instance of a possibly ordered attribute with no value.BasicAttribute
(String id, Object value) Constructs a new instance of an unordered attribute with a single value.BasicAttribute
(String id, Object value, boolean ordered) Constructs a new instance of a possibly ordered attribute with a single value. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds an attribute value to the ordered list of attribute values.boolean
Adds a new value to this attribute.void
clear()
Removes all values from this attribute.clone()
Creates and returns a copy of this object.boolean
Determines whether a value is in this attribute.boolean
Determines whether obj is equal to this attribute.get()
Retrieves one of this attribute's values.get
(int ix) Retrieves the attribute value from the ordered list of attribute values.getAll()
Retrieves an enumeration of this attribute's values.Retrieves this attribute's schema definition.Retrieves the syntax definition associated with this attribute.getID()
Retrieves the id of this attribute.int
hashCode()
Calculates the hash code of this attribute.boolean
Determines whether this attribute's values are ordered.remove
(int ix) Removes an attribute value from the ordered list of attribute values.boolean
Removes a specified value from this attribute.Sets an attribute value in the ordered list of attribute values.int
size()
Retrieves the number of values in this attribute.toString()
Generates the string representation of this attribute.
-
Field Details
-
attrID
Holds the attribute's id. It is initialized by the public constructor and cannot be null unless methods in BasicAttribute that use attrID have been overridden. -
values
Holds the attribute's values. Initialized by public constructors. Cannot be null unless methods in BasicAttribute that use values have been overridden. -
ordered
protected boolean orderedA flag for recording whether this attribute's values are ordered.
-
-
Constructor Details
-
BasicAttribute
Constructs a new instance of an unordered attribute with no value.- Parameters:
id
- The attribute's id. It cannot be null.
-
BasicAttribute
Constructs a new instance of an unordered attribute with a single value.- Parameters:
id
- The attribute's id. It cannot be null.value
- The attribute's value. If null, a null value is added to the attribute.
-
BasicAttribute
Constructs a new instance of a possibly ordered attribute with no value.- Parameters:
id
- The attribute's id. It cannot be null.ordered
- true means the attribute's values will be ordered; false otherwise.
-
BasicAttribute
Constructs a new instance of a possibly ordered attribute with a single value.- Parameters:
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 Details
-
clone
Description copied from class:Object
Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any objectx
, the expression:x.clone() != x
x.clone().getClass() == x.getClass()
true
, but these are not absolute requirements. While it is typically the case that:x.clone().equals(x)
true
, this is not an absolute requirement.By convention, the returned object should be obtained by calling
super.clone
. If a class and all of its superclasses (exceptObject
) obey this convention, it will be the case thatx.clone().getClass() == x.getClass()
.By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by
super.clone
before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned bysuper.clone
need to be modified. -
equals
Determines whether obj is equal to this attribute. Two attributes are equal if their attribute-ids, syntaxes and values are equal. If the attribute values are unordered, the order that the values were added are irrelevant. If the attribute values are ordered, then the order the values must match. If obj is null or not an Attribute, false is returned.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 usingObject.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 overridesequals()
, it should also overridehashCode()
such that two attributes that are equal have the same hash code. -
hashCode
public int hashCode()Calculates the hash code of this attribute.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 overrideequals()
as well so that two attributes that are equal have the same hash code. -
toString
Generates the string representation of this attribute. The string consists of the attribute's id and its values. This string is meant for debugging and not meant to be interpreted programmatically. -
getAll
Retrieves an enumeration of this attribute's values.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.
- Specified by:
getAll
in interfaceAttribute
- Returns:
- A non-null enumeration of the attribute's values. Each element of the enumeration is a possibly null Object. The object's class is the class of the attribute value. The element is null if the attribute's value is null. If the attribute has zero values, an empty enumeration is returned.
- Throws:
NamingException
- If a naming exception was encountered while retrieving the values.- See Also:
-
get
Retrieves one of this attribute's values.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.
- Specified by:
get
in interfaceAttribute
- Returns:
- A possibly null object representing one of the attribute's value. It is null if the attribute's value is null.
- Throws:
NamingException
- If a naming exception was encountered while retrieving the value.
-
size
public int size()Description copied from interface:Attribute
Retrieves the number of values in this attribute. -
getID
Description copied from interface:Attribute
Retrieves the id of this attribute. -
contains
Determines whether a value is in this attribute.By default,
Object.equals()
is used when comparingattrVal
with this attribute's values except whenattrVal
is an array. For an array, each element of the array is checked usingObject.equals()
. A subclass may use schema information to determine equality. -
add
Adds a new value to this attribute.By default,
Object.equals()
is used when comparingattrVal
with this attribute's values except whenattrVal
is an array. For an array, each element of the array is checked usingObject.equals()
. A subclass may use schema information to determine equality. -
remove
Removes a specified value from this attribute.By default,
Object.equals()
is used when comparingattrVal
with this attribute's values except whenattrVal
is an array. For an array, each element of the array is checked usingObject.equals()
. A subclass may use schema information to determine equality. -
clear
public void clear()Description copied from interface:Attribute
Removes all values from this attribute. -
isOrdered
public boolean isOrdered()Description copied from interface:Attribute
Determines whether this attribute's values are ordered. If an attribute's values are ordered, duplicate values are allowed. If an attribute's values are unordered, they are presented in any order and there are no duplicate values. -
get
Description copied from interface:Attribute
Retrieves the attribute value from the ordered list of attribute values. This method returns the value at theix
index of the list of attribute values. If the attribute values are unordered, this method returns the value that happens to be at that index.- Specified by:
get
in interfaceAttribute
- Parameters:
ix
- The index of the value in the ordered list of attribute values.0 <= ix < size()
.- Returns:
- The possibly null attribute value at index
ix
; null if the attribute value is null. - Throws:
NamingException
- If a naming exception was encountered while retrieving the value.
-
remove
Description copied from interface:Attribute
Removes an attribute value from the ordered list of attribute values. This method removes the value at theix
index of the list of attribute values. If the attribute values are unordered, this method removes the value that happens to be at that index. Values located at indices greater thanix
are shifted up towards the front of the list (and their indices decremented by one). -
add
Description copied from interface:Attribute
Adds an attribute value to the ordered list of attribute values. This method addsattrVal
to the list of attribute values at indexix
. Values located at indices at or greater thanix
are shifted down towards the end of the list (and their indices incremented by one). If the attribute values are unordered and already haveattrVal
,IllegalStateException
is thrown. -
set
Description copied from interface:Attribute
Sets an attribute value in the ordered list of attribute values. This method sets the value at theix
index of the list of attribute values to beattrVal
. The old value is removed. If the attribute values are unordered, this method sets the value that happens to be at that index toattrVal
, unlessattrVal
is already one of the values. In that case,IllegalStateException
is thrown.- Specified by:
set
in interfaceAttribute
- Parameters:
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.- Returns:
- The possibly null attribute value at index ix that was replaced. Null if the attribute value was null.
-
getAttributeSyntaxDefinition
Retrieves the syntax definition associated with this attribute.This method by default throws OperationNotSupportedException. A subclass should override this method if it supports schema.
- Specified by:
getAttributeSyntaxDefinition
in interfaceAttribute
- Returns:
- The attribute's syntax definition. Null if the implementation supports schemas but this particular attribute does not have any schema information.
- Throws:
OperationNotSupportedException
- If getting the schema is not supported.NamingException
- If a naming exception occurs while getting the schema.
-
getAttributeDefinition
Retrieves this attribute's schema definition.This method by default throws OperationNotSupportedException. A subclass should override this method if it supports schema.
- Specified by:
getAttributeDefinition
in interfaceAttribute
- Returns:
- This attribute's schema definition. Null if the implementation supports schemas but this particular attribute does not have any schema information.
- Throws:
OperationNotSupportedException
- If getting the schema is not supported.NamingException
- If a naming exception occurs while getting the schema.
-