com.entrust.toolkit

Class Set

java.lang.Object

com.entrust.toolkit.Set

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

CertificateSet, TestletDataSet

public class Set
extends java.lang.Object
implements java.lang.Cloneable

This generic set holds objects of a specified class.

One commonly used subclass is CertificateSet.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Class	m_class
protected java.util.Vector	m_set

Constructor Summary

Constructors

Constructor and Description
Set(java.lang.Class contentClass) Constructs a Set object specifying the class of the objects that can be added to this set.

Method Summary

Modifier and Type	Method and Description
boolean	addElement(java.lang.Object obj) Adds an object to the set.
Set	apply(Selector selector) Removes all objects from this set that do not conform to selector's criteria.
java.util.Enumeration	elements() Returns an enumeration of the elements of this set.
java.lang.Class	getContentClass() Returns the class of the content objects.
java.lang.Object[]	getElements() Returns all objects contained in this set.
Set	intersect(Set operand) The intersection set operation.
void	removeAll() Removes all objects from the set.
boolean	removeElement(java.lang.Object obj) Searches the set for an object that is equivalent to obj and removes it.
int	size() Returns the number of objects stored in this set.
Set	substract(Set operand) The difference (or subtraction) set operation.
Set	union(Set operand) The union set operation.

Methods inherited from class java.lang.Object

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

Field Detail

m_class

protected java.lang.Class m_class

m_set

protected java.util.Vector m_set

Constructor Detail

Set

public Set(java.lang.Class contentClass)
    throws java.lang.NullPointerException

Constructs a Set object specifying the class of the objects that can be added to this set.

Parameters:

contentClass - any object added to this set is checked against this class

Throws:

java.lang.NullPointerException - if contentClass is null

Method Detail

getContentClass

public java.lang.Class getContentClass()

Returns the class of the content objects.

Returns:

the class of which the objects contained in this set are guaranteed to be an instance

addElement

public final boolean addElement(java.lang.Object obj)
                         throws java.lang.ClassCastException,
                                java.lang.NullPointerException

Adds an object to the set.

The object added to the set must be an instance of the class specified in the constructor, or an instance of a subclass of the class specified in the constructor. If the object is already in the set, it is not added. The comparison with members of the set is done using the object's equals method.

Parameters:

obj - the object to add to the this set

Returns:

true if obj is added to this set, false otherwise - that is, because an equivalent object is already a member of the set

Throws:

java.lang.ClassCastException - thrown if obj is not an instance of the class specified in the constructor

java.lang.NullPointerException - thrown if obj is null

removeElement

public final boolean removeElement(java.lang.Object obj)
                            throws java.lang.NullPointerException

Searches the set for an object that is equivalent to obj and removes it.

The object's equals method is used for the comparison. obj does not have to be contained in the set; it is sufficient if there is an object obj2 such that obj.equals(obj2).

Parameters:

obj - if the set contains an object that is equal to obj, it is removed

Returns:

true if an object was found and removed, false if no object equal to obj was found

Throws:

java.lang.NullPointerException - if obj is null

removeAll

public final void removeAll()

Removes all objects from the set.

getElements

public final java.lang.Object[] getElements()

Returns all objects contained in this set. If this set is empty, this method returns an array with length 0.

Returns:

an array containing all objects of this set

elements

public final java.util.Enumeration elements()

Returns an enumeration of the elements of this set.

Returns:

an enumeration of the elements of this set

See Also:

Enumeration

size

public final int size()

Returns the number of objects stored in this set.

Returns:

the number of objects stored in this set

union

public final Set union(Set operand)
                throws java.lang.ClassCastException,
                       java.lang.NullPointerException

The union set operation.

This method creates a new set containing all objects that are either in the calling set, in operand, or in both. The objects of the two sets are compared using the equals method.

If an object in the calling set equals an object in operand, only the calling set's object are included in the new set. Neither the calling set nor operand are changed by this operation.

The returned set is created by cloning the set so it is of the same class as the calling set. The objects in operand must be of the class specified in the calling set's constructor.

Parameters:

operand - the set to be combined with the calling set

Returns:

a set that contains both the objects of the calling set and operand

Throws:

java.lang.ClassCastException - thrown if operand contains an object that is not of the class specified in the calling set's constructor

java.lang.NullPointerException - thrown if operand is null

intersect

public final Set intersect(Set operand)
                    throws java.lang.NullPointerException

The intersection set operation.

This method creates a new set containing all objects that are common to both the calling set and operand. The objects of the two sets are compared using the equals method.

Neither the calling set nor operand are changed by this operation. The returned set is created by cloning the set so it is of the same class as the calling set.

Parameters:

operand - the set to be compared with the calling set

Returns:

a set that contains the objects that are common to the calling set and to operand

Throws:

java.lang.NullPointerException - thrown if operand is null

substract

public final Set substract(Set operand)
                    throws java.lang.NullPointerException

The difference (or subtraction) set operation.

Creates a new set containing all objects that are contained in this set, but not in operand. The objects of the two sets are compared using the equals method.

Neither this set nor operand are changed by this operation. The returned set is created by cloning this set so it is of the same class as this set.

Parameters:

operand - the set to be compared with this set

Returns:

a set that contains the objects that are in this set, but not in operand

Throws:

java.lang.NullPointerException - thrown if operand is null

apply

public final Set apply(Selector selector)
                throws java.lang.ClassCastException,
                       java.lang.NullPointerException

Removes all objects from this set that do not conform to selector's criteria.

This method calls the selector's applyTo method. It returns a reference to itself so that calls to this method can be nested.

Parameters:

selector - the selector to apply to this set

Returns:

a reference to this set

Throws:

java.lang.ClassCastException - thrown if the selector does not know the class specified in this set's constructor

java.lang.NullPointerException - thrown if selector is null