javax.naming.directory

Class BasicAttributes

Implemented Interfaces:
Attributes, Cloneable, Serializable

public class BasicAttributes
extends Object
implements Attributes

Constructor Summary

BasicAttributes()
The basic constructor.
BasicAttributes(boolean ignoreCase)
BasicAttributes(String attrID, Object val)
BasicAttributes(String attrID, Object val, boolean ignoreCase)

Method Summary

Object
clone()
This method may be called to create a new copy of the Object.
boolean
equals(Object obj)
Returns true if and only if the given Object is an instance of Attributes, the given attributes both do or don't ignore case for IDs and the collection of attributes is the same.
Attribute
get(String attrID)
NamingEnumeration
getAll()
NamingEnumeration
getIDs()
int
hashCode()
Get a value that represents this Object, as uniquely as possible within the confines of an int.
boolean
isCaseIgnored()
Attribute
put(String attrID, Object val)
Attribute
put(Attribute attr)
Attribute
remove(String attrID)
int
size()
String
toString()
Convert this Object to a human-readable String.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BasicAttributes

public BasicAttributes()
The basic constructor. Object is special, because it has no superclass, so there is no call to super().

BasicAttributes

public BasicAttributes(boolean ignoreCase)

BasicAttributes

public BasicAttributes(String attrID,
                       Object val)

BasicAttributes

public BasicAttributes(String attrID,
                       Object val,
                       boolean ignoreCase)

Method Details

clone

public Object clone()
This method may be called to create a new copy of the Object. The typical behavior is as follows:
  • o == o.clone() is false
  • o.getClass() == o.clone().getClass() is true
  • o.equals(o) is true

However, these are not strict requirements, and may be violated if necessary. Of the three requirements, the last is the most commonly violated, particularly if the subclass does not override Object.equals(Object).

If the Object you call clone() on does not implement Cloneable (which is a placeholder interface), then a CloneNotSupportedException is thrown. Notice that Object does not implement Cloneable; this method exists as a convenience for subclasses that do.

Object's implementation of clone allocates space for the new Object using the correct class, without calling any constructors, and then fills in all of the new field values with the old field values. Thus, it is a shallow copy. However, subclasses are permitted to make a deep copy.

All array types implement Cloneable, and override this method as follows (it should never fail):

 public Object clone()
 {
   try
     {
       super.clone();
     }
   catch (CloneNotSupportedException e)
     {
       throw new InternalError(e.getMessage());
     }
 }
 
Specified by:
clone in interface Attributes
Overrides:
clone in interface Object
Returns:
a copy of the Object
See Also:
Cloneable

equals

public boolean equals(Object obj)
Returns true if and only if the given Object is an instance of Attributes, the given attributes both do or don't ignore case for IDs and the collection of attributes is the same.
Overrides:
equals in interface Object

get

public Attribute get(String attrID)
Specified by:
get in interface Attributes

getAll

public NamingEnumeration getAll()
Specified by:
getAll in interface Attributes

getIDs

public NamingEnumeration getIDs()
Specified by:
getIDs in interface Attributes

hashCode

public int hashCode()
Get a value that represents this Object, as uniquely as possible within the confines of an int.

There are some requirements on this method which subclasses must follow:

  • Semantic equality implies identical hashcodes. In other words, if a.equals(b) is true, then a.hashCode() == b.hashCode() must be as well. However, the reverse is not necessarily true, and two objects may have the same hashcode without being equal.
  • It must be consistent. Whichever value o.hashCode() returns on the first invocation must be the value returned on all later invocations as long as the object exists. Notice, however, that the result of hashCode may change between separate executions of a Virtual Machine, because it is not invoked on the same object.

Notice that since hashCode is used in Hashtable and other hashing classes, a poor implementation will degrade the performance of hashing (so don't blindly implement it as returning a constant!). Also, if calculating the hash is time-consuming, a class may consider caching the results.

The default implementation returns System.identityHashCode(this)

Overrides:
hashCode in interface Object
Returns:
the hash code for this Object

isCaseIgnored

public boolean isCaseIgnored()
Specified by:
isCaseIgnored in interface Attributes

put

public Attribute put(String attrID,
                     Object val)
Specified by:
put in interface Attributes

put

public Attribute put(Attribute attr)
Specified by:
put in interface Attributes

remove

public Attribute remove(String attrID)
Specified by:
remove in interface Attributes

size

public int size()
Specified by:
size in interface Attributes

toString

public String toString()
Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() and such.

It is typical, but not required, to ensure that this method never completes abruptly with a RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).

Overrides:
toString in interface Object
Returns:
the String representing this Object, which may be null

BasicAttributes.java -- Copyright (C) 2000, 2001, 2004, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.