Overview  Package   Class  Use  Deprecated  Index
Home >> All >> javax >> naming >> [ directory overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

javax.naming.directory
Class BasicAttribute  

java.lang.Object
  javax.naming.directory.BasicAttribute

All Implemented Interfaces:

Attribute, java.lang.Cloneable, java.io.Serializable

---

public class BasicAttribute

extends java.lang.Object

implements Attribute

Since:

1.3

---

Nested Class Summary
private  class	BasicAttribute.BasicAttributeEnumeration

 

Field Summary
protected  java.lang.String	attrID           The ID of this attribute.
protected  boolean	ordered           True if this attribute's values are ordered.
private static long	serialVersionUID
protected  java.util.Vector	values           Values for this attribute.

 

Constructor Summary
private	BasicAttribute()
	BasicAttribute(java.lang.String id)
	BasicAttribute(java.lang.String id, boolean ordered)
	BasicAttribute(java.lang.String id, java.lang.Object value)
	BasicAttribute(java.lang.String id, java.lang.Object value, boolean ordered)

 

Method Summary
void	add(int index, java.lang.Object val)
boolean	add(java.lang.Object val)
void	clear()
java.lang.Object	clone()           This method may be called to create a new copy of the Object.
boolean	contains(java.lang.Object val)
boolean	equals(java.lang.Object obj)           Determine whether this Object is semantically equal to another Object.
private  boolean	equals(java.lang.Object one, java.lang.Object two)
java.lang.Object	get()
java.lang.Object	get(int index)
javax.naming.NamingEnumeration	getAll()
DirContext	getAttributeDefinition()
DirContext	getAttributeSyntaxDefinition()
java.lang.String	getID()
int	hashCode()           Get a value that represents this Object, as uniquely as possible within the confines of an int.
boolean	isOrdered()
private  void	readObject(java.io.ObjectInputStream s)
java.lang.Object	remove(int index)
boolean	remove(java.lang.Object val)
java.lang.Object	set(int index, java.lang.Object val)
int	size()
java.lang.String	toString()           Convert this Object to a human-readable String.
private  void	writeObject(java.io.ObjectOutputStream s)

 

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

 

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

---

attrID

protected java.lang.String attrID

The ID of this attribute.

---

ordered

protected boolean ordered

True if this attribute's values are ordered.

---

values

protected transient java.util.Vector values

Values for this attribute.

Constructor Detail

BasicAttribute

private BasicAttribute()

---

BasicAttribute

public BasicAttribute(java.lang.String id)

---

BasicAttribute

public BasicAttribute(java.lang.String id,
                      boolean ordered)

---

BasicAttribute

public BasicAttribute(java.lang.String id,
                      java.lang.Object value)

---

BasicAttribute

public BasicAttribute(java.lang.String id,
                      java.lang.Object value,
                      boolean ordered)

Method Detail

add

public void add(int index,
                java.lang.Object val)

Specified by:

add in interface Attribute

---

add

public boolean add(java.lang.Object val)

Specified by:

add in interface Attribute

---

clear

public void clear()

Specified by:

clear in interface Attribute

---

clone

public java.lang.Object clone()

Description copied from class: java.lang.Object

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)>Object.equals(Object) 55 .

If the Object you call clone() on does not implement java.lang.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 Attribute

---

contains

public boolean contains(java.lang.Object val)

Specified by:

contains in interface Attribute

---

equals

public boolean equals(java.lang.Object obj)

Description copied from class: java.lang.Object

Determine whether this Object is semantically equal to another Object.

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

• It must be transitive. If a.equals(b) and b.equals(c), then a.equals(c) must be true as well.
• It must be symmetric. a.equals(b) and b.equals(a) must have the same value.
• It must be reflexive. a.equals(a) must always be true.
• It must be consistent. Whichever value a.equals(b) returns on the first invocation must be the value returned on all later invocations.
• a.equals(null) must be false.
• It must be consistent with hashCode(). That is, a.equals(b) must imply a.hashCode() == b.hashCode(). The reverse is not true; two objects that are not equal may have the same hashcode, but that has the potential to harm hashing performance.

This is typically overridden to throw a java.lang.ClassCastException if the argument is not comparable to the class performing the comparison, but that is not a requirement. It is legal for a.equals(b) to be true even though a.getClass() != b.getClass(). Also, it is typical to never cause a java.lang.NullPointerException.

In general, the Collections API (java.util) use the equals method rather than the == operator to compare objects. However, java.util.IdentityHashMap is an exception to this rule, for its own good reasons.

The default implementation returns this == o.

---

get

public java.lang.Object get()
                     throws javax.naming.NamingException

Specified by:

get in interface Attribute

---

get

public java.lang.Object get(int index)
                     throws javax.naming.NamingException

Specified by:

get in interface Attribute

---

getAll

public javax.naming.NamingEnumeration getAll()
                                      throws javax.naming.NamingException

Specified by:

getAll in interface Attribute

---

getAttributeDefinition

public DirContext getAttributeDefinition()
                                  throws javax.naming.OperationNotSupportedException,
                                         javax.naming.NamingException

Specified by:

getAttributeDefinition in interface Attribute

---

getAttributeSyntaxDefinition

public DirContext getAttributeSyntaxDefinition()
                                        throws javax.naming.OperationNotSupportedException,
                                               javax.naming.NamingException

Specified by:

getAttributeSyntaxDefinition in interface Attribute

---

getID

public java.lang.String getID()

Specified by:

getID in interface Attribute

---

hashCode

public int hashCode()

Description copied from class: java.lang.Object

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 java.util.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)

---

isOrdered

public boolean isOrdered()

Specified by:

isOrdered in interface Attribute

---

remove

public java.lang.Object remove(int index)

Specified by:

remove in interface Attribute

---

remove

public boolean remove(java.lang.Object val)

Specified by:

remove in interface Attribute

---

set

public java.lang.Object set(int index,
                            java.lang.Object val)

Specified by:

set in interface Attribute

---

size

public int size()

Specified by:

size in interface Attribute

---

toString

public java.lang.String toString()

Description copied from class: java.lang.Object

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() 55 and such.

It is typical, but not required, to ensure that this method never completes abruptly with a java.lang.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()).

---

equals

private boolean equals(java.lang.Object one,
                       java.lang.Object two)

---

readObject

private void readObject(java.io.ObjectInputStream s)
                 throws java.io.IOException,
                        java.lang.ClassNotFoundException

---

writeObject

private void writeObject(java.io.ObjectOutputStream s)
                  throws java.io.IOException

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> javax >> naming >> [ directory overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---