com.openmarket.directory

Class Attribute

java.lang.Object

com.openmarket.directory.common.BaseAttribute

com.openmarket.directory.Attribute

All Implemented Interfaces:

Serializable, Cloneable

public class Attribute
extends BaseAttribute
implements Cloneable, Serializable

This is essentially a wrapper around the JNDI Attribute class.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.openmarket.directory.common.BaseAttribute

m_impl

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Attribute(Attribute JNDIAttr) Hide this constructor
	Attribute(ICS ics, String id) Constructs a new instance of an unordered attribute with no value.
	Attribute(ICS ics, String id, boolean ordered)
	Attribute(ICS ics, String id, Object value) Constructs a new instance of an unordered attribute with a single value.
	Attribute(ICS ics, String id, Object value, boolean ordered) Constructs a new instance of a possibly ordered attribute with a single value.

Method Summary

Modifier and Type	Method and Description
void	add(int ix, Object attrVal) Adds an attribute value to the ordered list of attribute values.
boolean	add(Object attrVal) Adds a new value to this attribute.
void	clear() Removes all values from this attribute.
Object	clone() Makes a copy of the attribute.
boolean	contains(Object attrVal) Determines whether a value is in this attribute.
boolean	equals(Object obj) Determines whether obj is equal to this attribute.
Object	get() Retrieves one of this attribute's values.
Object	get(int ix) Retrieves the attribute value from the ordered list of attribute values.
Enumeration	getAll() Retrieves an enumeration of this attribute's values.
String	getID() Retrieves the id of this attribute.
int	hashCode() Calculates the hash code of this attribute.
boolean	isOrdered() Determines whether this attribute's values are ordered.
Object	remove(int ix) Removes an attribute value from the ordered list of attribute values.
boolean	remove(Object attrval) Removes a specified value from this attribute.
Object	set(int ix, Object attrVal) Sets an attribute value in the ordered list of attribute values.
int	size() Retrieves the number of values in this attribute.
String	toString() Generates the string representation of this attribute.

Methods inherited from class com.openmarket.directory.common.BaseAttribute

toJNDIAttribute

Methods inherited from class java.lang.Object

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

Constructor Detail

Attribute

protected Attribute(Attribute JNDIAttr)

Hide this constructor

Attribute

public Attribute(ICS ics,
                 String id,
                 boolean ordered)
          throws DirectoryException

Throws:

DirectoryException

Attribute

public Attribute(ICS ics,
                 String id)
          throws DirectoryException

Constructs a new instance of an unordered attribute with no value.

Parameters:

id - The attribute's id. It cannot be null.

Throws:

DirectoryException

Attribute

public Attribute(ICS ics,
                 String id,
                 Object value)
          throws DirectoryException

Constructs a new instance of an unordered attribute with a single value.

Parameters:

id - The attribute's id. It cannot be null.

value - The attribute's value. If null, a null value is added to the attribute.

Throws:

DirectoryException

Attribute

public Attribute(ICS ics,
                 String id,
                 Object value,
                 boolean ordered)
          throws DirectoryException

Constructs a new instance of a possibly ordered attribute with a single value.

Parameters:

id - The attribute's id. It cannot be null.

value - The attribute's value. If null, a null value is added to the attribute.

ordered - true means the attribute's values will be ordered; false otherwise.

Throws:

DirectoryException

Method Detail

add

public void add(int ix,
                Object attrVal)

Adds an attribute value to the ordered list of attribute values.

add

public boolean add(Object attrVal)

Adds a new value to this attribute.

clear

public void clear()

Removes all values from this attribute.

clone

public Object clone()

Makes a copy of the attribute.

Overrides:

clone in class Object

contains

public boolean contains(Object attrVal)

Determines whether a value is in this attribute.

equals

public boolean equals(Object obj)

Determines whether obj is equal to this attribute.

Overrides:

equals in class Object

get

public Object get()
           throws DirectoryException

Retrieves one of this attribute's values.

Throws:

DirectoryException

get

public Object get(int ix)
           throws DirectoryException

Retrieves the attribute value from the ordered list of attribute values.

Throws:

DirectoryException

getAll

public Enumeration getAll()
                   throws DirectoryException

Retrieves an enumeration of this attribute's values.

Throws:

DirectoryException

getID

public String getID()

Retrieves the id of this attribute.

hashCode

public int hashCode()

Calculates the hash code of this attribute.

Overrides:

hashCode in class Object

isOrdered

public boolean isOrdered()

Determines whether this attribute's values are ordered.

remove

public Object remove(int ix)

Removes an attribute value from the ordered list of attribute values.

remove

public boolean remove(Object attrval)

Removes a specified value from this attribute.

set

public Object set(int ix,
                  Object attrVal)

Sets an attribute value in the ordered list of attribute values.

size

public int size()

Retrieves the number of values in this attribute.

toString

public String toString()

Generates the string representation of this attribute.

Overrides:

toString in class Object