net.sourceforge.pain.db
Class DbStringSet

java.lang.Object
  net.sourceforge.pain.db.DbCollection
      net.sourceforge.pain.db.DbAbstractStringMap
          net.sourceforge.pain.db.DbStringSet

All Implemented Interfaces:

java.util.Collection, java.util.Set

public final class DbStringSet

extends net.sourceforge.pain.db.DbAbstractStringMap

implements java.util.Set

This class implements the Set interface. Only not null String values supported.
PAiN Db will not support more general serializable objects Set as it brokes database design
but Strings(Immutable) Sets are too convinient to be missed. This class is still experimental and could be removed with next release. (possible usage alternative: Cookie class and StingKeyMap)

Nested Class Summary

static class

DbCollection.ReadOnlyIterator

Constructor Summary

DbStringSet(DbObject owner, int fid)

DbStringSet(DbObject owner, java.lang.String[] image, int fid)

Method Summary

boolean	add(java.lang.Object o) Adds the specified element to this set if it is not already present (optional operation).
boolean	addAll(java.util.Collection c) Adds all of the elements in the specified collection to this set if they're not already present (optional operation).
void	clear() Removes all of the elements from this set (optional operation).
boolean	contains(java.lang.Object o) Returns true if this set contains the specified element.
boolean	containsAll(java.util.Collection c) Returns true if this set contains all of the elements of the specified collection.
boolean	isEmpty() Returns true if this set contains no elements.
java.util.Iterator	iterator() Returns an iterator over the elements in this set.
boolean	remove(java.lang.Object o) Removes the specified element from this set if it is present (optional operation).
boolean	removeAll(java.util.Collection c) Removes from this set all of its elements that are contained in the specified collection (optional operation).
boolean	retainAll(java.util.Collection c) Retains only the elements in this set that are contained in the specified collection (optional operation).
int	size() Returns the number of elements in this set (its cardinality).
java.lang.Object[]	toArray() Returns an array containing all of the elements in this set.
java.lang.Object[]	toArray(java.lang.Object[] a) Returns an array containing all of the elements in this set; the runtime type of the returned array is that of the specified array.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Set

equals, hashCode

Constructor Detail

DbStringSet

public DbStringSet(DbObject owner,
                   java.lang.String[] image,
                   int fid)

DbStringSet

public DbStringSet(DbObject owner,
                   int fid)

Method Detail

size

public int size()

Description copied from interface: java.util.Set

Returns the number of elements in this set (its cardinality). If this set contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Specified by:

size in interface java.util.Set

Returns:

the number of elements in this set (its cardinality).

clear

public void clear()

Description copied from interface: java.util.Set

Removes all of the elements from this set (optional operation). This set will be empty after this call returns (unless it throws an exception).

Specified by:

clear in interface java.util.Set

isEmpty

public boolean isEmpty()

Description copied from interface: java.util.Set

Returns true if this set contains no elements.

Specified by:

isEmpty in interface java.util.Set

Returns:

true if this set contains no elements.

toArray

public java.lang.Object[] toArray()

Description copied from interface: java.util.Set

Returns an array containing all of the elements in this set. Obeys the general contract of the Collection.toArray method.

Specified by:

toArray in interface java.util.Set

Returns:

an array containing all of the elements in this set.

add

public boolean add(java.lang.Object o)

Description copied from interface: java.util.Set

Adds the specified element to this set if it is not already present (optional operation). More formally, adds the specified element, o, to this set if this set contains no element e such that (o==null ? e==null : o.equals(e)). If this set already contains the specified element, the call leaves this set unchanged and returns false. In combination with the restriction on constructors, this ensures that sets never contain duplicate elements.

The stipulation above does not imply that sets must accept all elements; sets may refuse to add any particular element, including null, and throwing an exception, as described in the specification for Collection.add. Individual set implementations should clearly document any restrictions on the the elements that they may contain.

Specified by:

add in interface java.util.Set

Parameters:

o - element to be added to this set.

Returns:

true if this set did not already contain the specified element.

contains

public boolean contains(java.lang.Object o)

Description copied from interface: java.util.Set

Returns true if this set contains the specified element. More formally, returns true if and only if this set contains an element e such that (o==null ? e==null : o.equals(e)).

Specified by:

contains in interface java.util.Set

Parameters:

o - element whose presence in this set is to be tested.

Returns:

true if this set contains the specified element.

remove

public boolean remove(java.lang.Object o)

Description copied from interface: java.util.Set

Removes the specified element from this set if it is present (optional operation). More formally, removes an element e such that (o==null ? e==null : o.equals(e)), if the set contains such an element. Returns true if the set contained the specified element (or equivalently, if the set changed as a result of the call). (The set will not contain the specified element once the call returns.)

Specified by:

remove in interface java.util.Set

Parameters:

o - object to be removed from this set, if present.

Returns:

true if the set contained the specified element.

addAll

public boolean addAll(java.util.Collection c)

Description copied from interface: java.util.Set

Adds all of the elements in the specified collection to this set if they're not already present (optional operation). If the specified collection is also a set, the addAll operation effectively modifies this set so that its value is the union of the two sets. The behavior of this operation is unspecified if the specified collection is modified while the operation is in progress.

Specified by:

addAll in interface java.util.Set

Parameters:

c - collection whose elements are to be added to this set.

Returns:

true if this set changed as a result of the call.

See Also:

Set.add(Object)

containsAll

public boolean containsAll(java.util.Collection c)

Description copied from interface: java.util.Set

Returns true if this set contains all of the elements of the specified collection. If the specified collection is also a set, this method returns true if it is a subset of this set.

Specified by:

containsAll in interface java.util.Set

Parameters:

c - collection to be checked for containment in this set.

Returns:

true if this set contains all of the elements of the specified collection.

See Also:

Set.contains(Object)

removeAll

public boolean removeAll(java.util.Collection c)

Description copied from interface: java.util.Set

Removes from this set all of its elements that are contained in the specified collection (optional operation). If the specified collection is also a set, this operation effectively modifies this set so that its value is the asymmetric set difference of the two sets.

Specified by:

removeAll in interface java.util.Set

Parameters:

c - collection that defines which elements will be removed from this set.

Returns:

true if this set changed as a result of the call.

See Also:

Set.remove(Object)

retainAll

public boolean retainAll(java.util.Collection c)

Description copied from interface: java.util.Set

Retains only the elements in this set that are contained in the specified collection (optional operation). In other words, removes from this set all of its elements that are not contained in the specified collection. If the specified collection is also a set, this operation effectively modifies this set so that its value is the intersection of the two sets.

Specified by:

retainAll in interface java.util.Set

Parameters:

c - collection that defines which elements this set will retain.

Returns:

true if this collection changed as a result of the call.

See Also:

Set.remove(Object)

iterator

public java.util.Iterator iterator()

Description copied from interface: java.util.Set

Returns an iterator over the elements in this set. The elements are returned in no particular order (unless this set is an instance of some class that provides a guarantee).

Specified by:

iterator in interface java.util.Set

Returns:

an iterator over the elements in this set.

toArray

public java.lang.Object[] toArray(java.lang.Object[] a)

Description copied from interface: java.util.Set

Returns an array containing all of the elements in this set; the runtime type of the returned array is that of the specified array. Obeys the general contract of the Collection.toArray(Object[]) method.

Specified by:

toArray in interface java.util.Set

Parameters:

a - the array into which the elements of this set are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.

Returns:

an array containing the elements of this set.