public class BasicAttributes extends Object implements Attributes
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.
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 Formpublic BasicAttributes()
Constructs a new instance of Attributes. The character case of attribute identifiers is significant when subsequently retrieving or adding attributes.
public BasicAttributes(boolean ignoreCase)
Constructs a new instance of Attributes. If 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)
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.
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)
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.
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()
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 object x
, the expression:
x.clone() != xwill be true, and that the expression:
x.clone().getClass() == x.getClass()will be
true
, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x)will be
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 Attributes
clone
in class Object
Cloneable
public boolean isCaseIgnored()
Description copied from interface: Attributes
Determines whether the attribute set ignores the case of attribute identifiers when retrieving or adding attributes.
isCaseIgnored
in interface Attributes
public int size()
Description copied from interface: Attributes
Retrieves the number of attributes in the attribute set.
size
in interface Attributes
public Attribute get(String attrID)
Description copied from interface: Attributes
Retrieves the attribute with the given attribute id from the attribute set.
get
in interface Attributes
attrID
- 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()
Description copied from interface: Attributes
Retrieves an enumeration of the attributes in the attribute set. The effects of updates to this attribute set on this enumeration are undefined.
getAll
in interface Attributes
Attribute
. If attribute set has zero attributes, an empty enumeration is returned.public NamingEnumeration<String> getIDs()
Description copied from interface: Attributes
Retrieves an enumeration of the ids of the attributes in the attribute set. The effects of updates to this attribute set on this enumeration are undefined.
getIDs
in interface Attributes
public Attribute put(String attrID, Object val)
Description copied from interface: Attributes
Adds a new attribute to the attribute set.
put
in interface Attributes
attrID
- 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)
Description copied from interface: Attributes
Adds a new attribute to the attribute set.
put
in interface Attributes
attr
- 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)
Description copied from interface: Attributes
Removes the attribute with the attribute id 'attrID' from the attribute set. If the attribute does not exist, ignore.
remove
in interface Attributes
attrID
- 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()
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.
toString
in class Object
public 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. 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.
equals
in class Object
obj
- the possibly null object to compare against.hashCode()
public int hashCode()
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.
hashCode
in class Object
equals(java.lang.Object)
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.