public class BasicAttributes extends Object implements Attributes
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.
DirContext.getAttributes(javax.naming.Name),
DirContext.modifyAttributes(javax.naming.Name, int, javax.naming.directory.Attributes),
DirContext.bind(javax.naming.Name, java.lang.Object, javax.naming.directory.Attributes),
DirContext.rebind(javax.naming.Name, java.lang.Object, javax.naming.directory.Attributes),
DirContext.createSubcontext(javax.naming.Name, javax.naming.directory.Attributes),
DirContext.search(javax.naming.Name, javax.naming.directory.Attributes, java.lang.String[]),
Serialized Form| Constructor and Description |
|---|
BasicAttributes()
Constructs a new instance of Attributes.
|
BasicAttributes(boolean ignoreCase)
Constructs a new instance of Attributes.
|
BasicAttributes(String attrID,
Object val)
Constructs a new instance of Attributes with one attribute.
|
BasicAttributes(String attrID,
Object val,
boolean ignoreCase)
Constructs a new instance of Attributes with one attribute.
|
| Modifier and Type | Method and Description |
|---|---|
Object |
clone()
Creates and returns a copy of this object.
|
boolean |
equals(Object obj)
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.
|
Attribute |
get(String attrID)
Retrieves the attribute with the given attribute id from the
attribute set.
|
NamingEnumeration<Attribute> |
getAll()
Retrieves an enumeration of the attributes in the attribute set.
|
NamingEnumeration<String> |
getIDs()
Retrieves an enumeration of the ids of the attributes in the
attribute set.
|
int |
hashCode()
Calculates the hash code of this BasicAttributes.
|
boolean |
isCaseIgnored()
Determines whether the attribute set ignores the case of
attribute identifiers when retrieving or adding attributes.
|
Attribute |
put(Attribute attr)
Adds a new attribute to the attribute set.
|
Attribute |
put(String attrID,
Object val)
Adds a new attribute to the attribute set.
|
Attribute |
remove(String attrID)
Removes the attribute with the attribute id 'attrID' from
the attribute set.
|
int |
size()
Retrieves the number of attributes in the attribute set.
|
String |
toString()
Generates the string representation of this attribute set.
|
public BasicAttributes()
public BasicAttributes(boolean ignoreCase)
ignoreCase is true, the character case of attribute
identifiers is ignored; otherwise the case is significant.ignoreCase - true means this attribute set will ignore
the case of its attribute identifiers
when retrieving or adding attributes;
false means case is respected.public BasicAttributes(String attrID, Object val)
attrID - non-null The id of the attribute to add.val - The value of the attribute to add. If null, a null
value is added to the attribute.public BasicAttributes(String attrID, Object val, boolean ignoreCase)
ignoreCase is true, the character case of attribute
identifiers is ignored; otherwise the case is significant.attrID - non-null The id of the attribute to add.
If this attribute set ignores the character
case of its attribute ids, the case of attrID
is ignored.val - The value of the attribute to add. If null, a null
value is added to the attribute.ignoreCase - true means this attribute set will ignore
the case of its attribute identifiers
when retrieving or adding attributes;
false means case is respected.public Object clone()
Objectx, the expression:
will be true, and that the expression:x.clone() != x
will bex.clone().getClass() == x.getClass()
true, but these are not absolute requirements.
While it is typically the case that:
will bex.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 (except
Object) obey this convention, it will be the case that
x.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 by super.clone
need to be modified.
The method clone for class Object performs a
specific cloning operation. First, if the class of this object does
not implement the interface Cloneable, then a
CloneNotSupportedException is thrown. Note that all arrays
are considered to implement the interface Cloneable and that
the return type of the clone method of an array type T[]
is T[] where T is any reference or primitive type.
Otherwise, this method creates a new instance of the class of this
object and initializes all its fields with exactly the contents of
the corresponding fields of this object, as if by assignment; the
contents of the fields are not themselves cloned. Thus, this method
performs a "shallow copy" of this object, not a "deep copy" operation.
The class Object does not itself implement the interface
Cloneable, so calling the clone method on an object
whose class is Object will result in throwing an
exception at run time.
clone in interface Attributesclone in class ObjectCloneablepublic boolean isCaseIgnored()
AttributesisCaseIgnored in interface Attributespublic int size()
Attributessize in interface Attributespublic Attribute get(String attrID)
Attributesget in interface AttributesattrID - The non-null id of the attribute to retrieve.
If this attribute set ignores the character
case of its attribute ids, the case of attrID
is ignored.Attributes.put(java.lang.String, java.lang.Object),
Attributes.remove(java.lang.String)public NamingEnumeration<Attribute> getAll()
AttributesgetAll in interface Attributespublic NamingEnumeration<String> getIDs()
AttributesgetIDs in interface Attributespublic Attribute put(String attrID, Object val)
Attributesput in interface AttributesattrID - non-null The id of the attribute to add.
If the attribute set ignores the character
case of its attribute ids, the case of attrID
is ignored.val - The possibly null value of the attribute to add.
If null, the attribute does not have any values.Attributes.remove(java.lang.String)public Attribute put(Attribute attr)
Attributesput in interface Attributesattr - The non-null attribute to add.
If the attribute set ignores the character
case of its attribute ids, the case of
attr's identifier is ignored.Attributes.remove(java.lang.String)public Attribute remove(String attrID)
Attributesremove in interface AttributesattrID - The non-null id of the attribute to remove.
If the attribute set ignores the character
case of its attribute ids, the case of
attrID is ignored.public String toString()
public boolean equals(Object obj)
equals in class Objectobj - the possibly null object to compare against.hashCode()public int hashCode()
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.
hashCode in class Objectequals(java.lang.Object) Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2016, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.