| |
|
| java.lang.Object
 javax.naming.directory.BasicAttributes
| BasicAttributes | | public class BasicAttributes implements Attributes(Code) | | This class provides a basic implementation
of the Attributes interface.
BasicAttributes is either case-sensitive or case-insensitive (case-ignore).
This property is determined at the time the BasicAttributes constructor
is called.
In a case-insensitive BasicAttributes, the case of its attribute identifiers
is ignored when searching for an attribute, or adding attributes.
In a case-sensitive BasicAttributes, the case is significant.
When the BasicAttributes class needs to create an Attribute, it
uses BasicAttribute. There is no other dependency on BasicAttribute.
Note that updates to BasicAttributes (such as adding or removing an attribute)
does not affect the corresponding representation in the directory.
Updates to the directory can only be effected
using operations in the DirContext interface.
A BasicAttributes instance is not synchronized against concurrent
multithreaded access. Multiple threads trying to access and modify
a single BasicAttributes instance should lock the object.
author:
Rosanna Lee
author:
Scott Seligman
version:
1.19 07/05/05
See Also: DirContext.getAttributes
See Also: DirContext.modifyAttributes
See Also: DirContext.bind
See Also: DirContext.rebind
See Also: DirContext.createSubcontext
See Also: DirContext.search
since:
1.3 |
| Constructor Summary | |
| public | BasicAttributes()
Constructs a new instance of Attributes. | | public | BasicAttributes(boolean ignoreCase)
Constructs a new instance of Attributes. | | public | BasicAttributes(String attrID, Object val)
Constructs a new instance of Attributes with one attribute.
The attribute specified by attrID and val are added to the newly
created attribute.
The character case of attribute identifiers
is significant when subsequently retrieving or adding attributes.
Parameters:
attrID - non-null The id of the attribute to add.
Parameters:
val - The value of the attribute to add. | | public | BasicAttributes(String attrID, Object val, boolean ignoreCase)
Constructs a new instance of Attributes with one attribute.
The attribute specified by attrID and val are added to the newly
created attribute.
If ignoreCase is true, the character case of attribute
identifiers is ignored; otherwise the case is significant.
Parameters:
attrID - non-null The id of the attribute to add.If this attribute set ignores the charactercase of its attribute ids, the case of attrIDis ignored.
Parameters:
val - The value of the attribute to add. |
| BasicAttributes | | public BasicAttributes()(Code) | | Constructs a new instance of Attributes.
The character case of attribute identifiers
is significant when subsequently retrieving or adding attributes.
|
| BasicAttributes | | public BasicAttributes(boolean ignoreCase)(Code) | | Constructs a new instance of Attributes.
If ignoreCase is true, the character case of attribute
identifiers is ignored; otherwise the case is significant.
Parameters:
ignoreCase - true means this attribute set will ignorethe case of its attribute identifierswhen retrieving or adding attributes;false means case is respected. |
| BasicAttributes | | public BasicAttributes(String attrID, Object val)(Code) | | Constructs a new instance of Attributes with one attribute.
The attribute specified by attrID and val are added to the newly
created attribute.
The character case of attribute identifiers
is significant when subsequently retrieving or adding attributes.
Parameters:
attrID - non-null The id of the attribute to add.
Parameters:
val - The value of the attribute to add. If null, a nullvalue is added to the attribute. |
| BasicAttributes | | public BasicAttributes(String attrID, Object val, boolean ignoreCase)(Code) | | Constructs a new instance of Attributes with one attribute.
The attribute specified by attrID and val are added to the newly
created attribute.
If ignoreCase is true, the character case of attribute
identifiers is ignored; otherwise the case is significant.
Parameters:
attrID - non-null The id of the attribute to add.If this attribute set ignores the charactercase of its attribute ids, the case of attrIDis ignored.
Parameters:
val - The value of the attribute to add. If null, a nullvalue is added to the attribute.
Parameters:
ignoreCase - true means this attribute set will ignorethe case of its attribute identifierswhen retrieving or adding attributes;false means case is respected. |
| equals | | public boolean equals(Object obj)(Code) | | Determines whether this BasicAttributes is equal to another
Attributes
Two Attributes are equal if they are both instances of
Attributes,
treat the case of attribute IDs the same way, and contain the
same attributes. Each Attribute in this BasicAttributes
is checked for equality using Object.equals(), which may have
be overridden by implementations of Attribute).
If a subclass overrides equals(),
it should override hashCode()
as well so that two Attributes instances that are equal
have the same hash code.
Parameters:
obj - the possibly null object to compare against. true If obj is equal to this BasicAttributes.
See Also: BasicAttributes.hashCode |
| hashCode | | public int hashCode()(Code) | | Calculates the hash code of this BasicAttributes.
The hash code is computed by adding the hash code of
the attributes of this object. If this BasicAttributes
ignores case of its attribute IDs, one is added to the hash code.
If a subclass overrides hashCode(),
it should override equals()
as well so that two Attributes instances that are equal
have the same hash code.
an int representing the hash code of this BasicAttributes instance.
See Also: BasicAttributes.equals |
| isCaseIgnored | | public boolean isCaseIgnored()(Code) | | |
| toString | | public String toString()(Code) | | Generates the string representation of this attribute set.
The string consists of each attribute identifier and the contents
of each attribute. The contents of this string is useful
for debugging and is not meant to be interpreted programmatically.
A non-null string listing the contents of this attribute set. |
|
|
|