com.sun.jdo.spi.persistence.support.sqlstore.sco

Class HashSet

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<E>

java.util.HashSet

com.sun.jdo.spi.persistence.support.sqlstore.sco.HashSet

All Implemented Interfaces:

SCO, SCOCollection, Serializable, Cloneable, Iterable, Collection, Set

public class HashSet
extends HashSet
implements SCOCollection

A mutable 2nd class object date.

Version:

1.0

Author:

Marina Vatkina

See Also:

HashSet, Serialized Form

Constructor Summary

Constructors

Constructor and Description
HashSet(Object owner, String fieldName, Class elementType, boolean allowNulls) Creates a new empty HashSet object.
HashSet(Object owner, String fieldName, Class elementType, boolean allowNulls, int initialCapacity) Creates a new empty HashSet object that has the specified initial capacity.Assigns owning object and field name.

Method Summary

Modifier and Type	Method and Description
boolean	add(Object o) Adds the specified element to this set if it is not already present.
boolean	addAll(Collection c) Adds all of the elements in the specified collection to this collection
void	addAllInternal(Collection c) Adds a Collection to the list without recording changes if the HashSet is not deferred.
void	addInternal(Object o) Adds an object to the list without recording changes if the HashSet is not deferred.
void	addToBaseCollection(Object o) Adds an object to the list without recording changes.
void	applyDeferredUpdates(Collection c) If the HashSet is deferred, we first initialize the internal collection with c and they apply any deferred updates specified by the added and removed lists.
void	applyUpdates(StateManager sm, boolean modified) Apply changes (can be a no-op)
void	clear() Removes all of the elements from this set.
void	clearInternal() Clears Collection without notifing the owner
Object	clone() Creates and returns a copy of this object.
Object	cloneInternal() Creates and returns a copy of this object without resetting the owner and field value.
Collection	getAdded() Returns added collection
String	getFieldName() Returns the field name
Object	getOwner() Returns the owner object of the SCO instance
Collection	getRemoved() Returns removed collection
boolean	isDeferred() Return true is this HashSet is deferred, false otherwise.
Iterator	iterator() Returns an iterator over the elements in this set.
StateManager	makeDirty() Marks object dirty
void	markDeferred() Mark this HashSet as deferred.
boolean	remove(Object o) Removes the given element from this set if it is present.
boolean	removeAll(Collection c) Removes from this collection all of its elements that are contained in the specified collection (optional operation).
void	removeAllInternal(Collection c) Removes objects of the given Collection from this Collection without recording the event.
void	removeInternal(Object o) Removes an element without notifing the owner
void	reset() Cleans removed and added lists
boolean	retainAll(Collection c) Retains only the elements in this collection that are contained in the specified collection (optional operation).
void	setOwner(Object owner, String fieldName, Class elementType) Set the owner if this instance is not owned.
void	unsetOwner() Nullifies references to the owner Object and Field

Methods inherited from class java.util.HashSet

contains, isEmpty, size, spliterator

Methods inherited from class java.util.AbstractSet

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

contains, containsAll, equals, hashCode, isEmpty, parallelStream, removeIf, size, spliterator, stream, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

containsAll, equals, hashCode, toArray, toArray

Constructor Detail

HashSet

public HashSet(Object owner,
               String fieldName,
               Class elementType,
               boolean allowNulls)

Creates a new empty HashSet object. Assigns owning object and field name.

Parameters:

owner - the owning object

fieldName - the owning field name

elementType - the element types allowed

allowNulls - true if nulls are allowed

HashSet

public HashSet(Object owner,
               String fieldName,
               Class elementType,
               boolean allowNulls,
               int initialCapacity)

Creates a new empty HashSet object that has the specified initial capacity.Assigns owning object and field name.

Parameters:

owner - the owning object

fieldName - the owning field name

elementType - the element types allowed

allowNulls - true if nulls are allowed

initialCapacity - the initial capacity of the hash map.

Throws:

IllegalArgumentException - if the initial capacity is less than zero.

See Also:

HashSet

Method Detail

add

public boolean add(Object o)

Adds the specified element to this set if it is not already present.

Specified by:

add in interface Collection

Specified by:

add in interface Set

Overrides:

add in class HashSet

Parameters:

o - element to be added to this set.

Returns:

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

See Also:

HashSet

addAll

public boolean addAll(Collection c)

Adds all of the elements in the specified collection to this collection

Specified by:

addAll in interface Collection

Specified by:

addAll in interface Set

Overrides:

addAll in class AbstractCollection

Parameters:

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

Returns:

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

Throws:

UnsupportedOperationException - if the addAll method is not supported by this collection.

See Also:

AbstractCollection, HashSet

remove

public boolean remove(Object o)

Removes the given element from this set if it is present.

Specified by:

remove in interface Collection

Specified by:

remove in interface Set

Overrides:

remove in class HashSet

Parameters:

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

Returns:

true if the set contained the specified element.

See Also:

HashSet

removeAll

public boolean removeAll(Collection c)

Removes from this collection all of its elements that are contained in the specified collection (optional operation).

Specified by:

removeAll in interface Collection

Specified by:

removeAll in interface Set

Overrides:

removeAll in class AbstractSet

Parameters:

c - elements to be removed from this collection.

Returns:

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

Throws:

UnsupportedOperationException - removeAll is not supported by this collection.

See Also:

HashSet, AbstractCollection

retainAll

public boolean retainAll(Collection c)

Retains only the elements in this collection that are contained in the specified collection (optional operation).

Specified by:

retainAll in interface Collection

Specified by:

retainAll in interface Set

Overrides:

retainAll in class AbstractCollection

Returns:

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

Throws:

UnsupportedOperationException - if the retainAll method is not supported by this collection.

See Also:

HashSet, AbstractCollection

clear

public void clear()

Removes all of the elements from this set.

Specified by:

clear in interface Collection

Specified by:

clear in interface Set

Overrides:

clear in class HashSet

See Also:

HashSet

clone

public Object clone()

Creates and returns a copy of this object.

Mutable Second Class Objects are required to provide a public clone method in order to allow for copying PersistenceCapable objects. In contrast to Object.clone(), this method must not throw a CloneNotSupportedException.

Overrides:

clone in class HashSet

iterator

public Iterator iterator()

Returns an iterator over the elements in this set. The elements are returned in no particular order.

Specified by:

iterator in interface Iterable

Specified by:

iterator in interface Collection

Specified by:

iterator in interface Set

Overrides:

iterator in class HashSet

Returns:

an Iterator over the elements in this set.

See Also:

ConcurrentModificationException

cloneInternal

public Object cloneInternal()

Creates and returns a copy of this object without resetting the owner and field value.

Specified by:

cloneInternal in interface SCO

reset

public void reset()

Cleans removed and added lists

Specified by:

reset in interface SCOCollection

markDeferred

public void markDeferred()

Mark this HashSet as deferred.

Specified by:

markDeferred in interface SCOCollection

isDeferred

public boolean isDeferred()

Return true is this HashSet is deferred, false otherwise.

Specified by:

isDeferred in interface SCOCollection

applyDeferredUpdates

public void applyDeferredUpdates(Collection c)

If the HashSet is deferred, we first initialize the internal collection with c and they apply any deferred updates specified by the added and removed lists.

Specified by:

applyDeferredUpdates in interface SCOCollection

addInternal

public void addInternal(Object o)

Adds an object to the list without recording changes if the HashSet is not deferred. Otherwise, add o to the added list.

Specified by:

addInternal in interface SCOCollection

addAllInternal

public void addAllInternal(Collection c)

Adds a Collection to the list without recording changes if the HashSet is not deferred. Otherwise, add o to the removed list.

Specified by:

addAllInternal in interface SCOCollection

addToBaseCollection

public void addToBaseCollection(Object o)

Description copied from interface: SCOCollection

Adds an object to the list without recording changes.

Specified by:

addToBaseCollection in interface SCOCollection

removeAllInternal

public void removeAllInternal(Collection c)

Description copied from interface: SCOCollection

Removes objects of the given Collection from this Collection without recording the event. Used internaly to remove a collection of elements from this collection.

Specified by:

removeAllInternal in interface SCOCollection

getAdded

public Collection getAdded()

Returns added collection

Specified by:

getAdded in interface SCOCollection

Returns:

added collection of added elements

getRemoved

public Collection getRemoved()

Returns removed collection

Specified by:

getRemoved in interface SCOCollection

Returns:

removed collection of removed elements

clearInternal

public void clearInternal()

Clears Collection without notifing the owner

Specified by:

clearInternal in interface SCOCollection

removeInternal

public void removeInternal(Object o)

Removes an element without notifing the owner

Specified by:

removeInternal in interface SCOCollection

unsetOwner

public void unsetOwner()

Nullifies references to the owner Object and Field

Specified by:

unsetOwner in interface SCO

getOwner

public Object getOwner()

Returns the owner object of the SCO instance

Specified by:

getOwner in interface SCO

Returns:

owner object

getFieldName

public String getFieldName()

Returns the field name

Specified by:

getFieldName in interface SCO

Returns:

field name as java.lang.String

makeDirty

public StateManager makeDirty()

Marks object dirty

Specified by:

makeDirty in interface SCO

Returns:

StateManager associated with the owner

applyUpdates

public void applyUpdates(StateManager sm,
                         boolean modified)

Apply changes (can be a no-op)

Specified by:

applyUpdates in interface SCO

setOwner

public void setOwner(Object owner,
                     String fieldName,
                     Class elementType)

Set the owner if this instance is not owned.

Specified by:

setOwner in interface SCOCollection

Parameters:

owner - the new owner.

fieldName - the new field name.

elementType - the new element type as Class, or null if type is not checked or not supported.

See Also:

SCOCollection.setOwner(java.lang.Object, java.lang.String, java.lang.Class)