- java.lang.Object
-
- java.util.AbstractCollection<E>
-
- java.util.AbstractSet<E>
-
- org.datanucleus.store.types.wrappers.Set<E>
-
- All Implemented Interfaces:
Serializable
,Cloneable
,Iterable<E>
,Collection<E>
,Set<E>
,SCO<Set<E>>
,SCOCollection<Set<E>,E>
,SCOContainer<Set<E>>
- Direct Known Subclasses:
Set
public class Set<E> extends AbstractSet<E> implements SCOCollection<Set<E>,E>, Cloneable, Serializable
A mutable second-class Set object. This is the simplified form that intercepts mutators and marks the field as dirty. It also handles cascade-delete triggering for persistable elements.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected Set<E>
delegate
The internal "delegate".protected AbstractMemberMetaData
ownerMmd
protected DNStateManager
ownerSM
-
Constructor Summary
Constructors Constructor Description Set(DNStateManager sm, AbstractMemberMetaData mmd)
Constructor, using StateManager of the "owner" and the field name.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
add(E element)
Method to add an element to the Collection.boolean
addAll(Collection<? extends E> elements)
Method to add a collection of elements.void
attachCopy(Set value)
Method to return an attached copy of the passed (detached) value.void
clear()
Method to clear the Collection.Object
clone()
Creates and returns a copy of this object.boolean
contains(Object element)
Accessor for whether an element is contained in the Collection.boolean
containsAll(Collection c)
Accessor for whether a collection of elements are contained here.Set
detachCopy(FetchPlanState state)
Method to return a detached copy of the container.boolean
equals(Object o)
Equality operator.void
forEach(Consumer<? super E> action)
String
getFieldName()
Accessor for the field name.Object
getOwner()
Accessor for the owner object.Set<E>
getValue()
Accessor for the unwrapped value that we are wrapping.int
hashCode()
Hashcode operator.void
initialise()
Method to initialise the SCO for use, and allowing the SCO to be loaded from the datastore (when we have a backing store).void
initialise(Set c)
Method to initialise the SCO for use with the provided initial value.void
initialise(Set<E> newValue, Object oldValue)
Method to initialise the SCO for use, where replacing an old value with a new value such as when calling a setter field passing in a new value.boolean
isEmpty()
Accessor for whether the Collection is empty.boolean
isLoaded()
Method to return if the SCO has its contents loaded.Iterator<E>
iterator()
Accessor for an iterator for the Collection.void
load()
Method to effect the load of the data in the SCO.void
makeDirty()
Utility to mark the object as dirtyStream
parallelStream()
boolean
remove(Object element)
Method to remove an element from the Listboolean
remove(Object element, boolean allowCascadeDelete)
Method to remove an element from the Listboolean
removeAll(Collection elements)
Method to remove a Collection of elements.boolean
retainAll(Collection c)
Method to retain a Collection of elements (and remove all others).void
setValue(Set<E> value)
Method to change the delegate value this wraps (to save recreating the wrapper).int
size()
Accessor for the size of the Collection.Spliterator
spliterator()
Stream
stream()
Object[]
toArray()
Method to return the Collection as an array.<T> T[]
toArray(T[] a)
Method to return the Collection as an array.void
unsetOwner()
Method to unset the owner and field information.void
updateEmbeddedElement(E element, int fieldNumber, Object value, boolean makeDirty)
Method to update an embedded element in this collection.protected Object
writeReplace()
The writeReplace method is called when ObjectOutputStream is preparing to write the object to the stream.-
Methods inherited from class java.util.AbstractCollection
toString
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Collection
removeIf, toArray
-
-
-
-
Field Detail
-
ownerSM
protected transient DNStateManager ownerSM
-
ownerMmd
protected transient AbstractMemberMetaData ownerMmd
-
-
Constructor Detail
-
Set
public Set(DNStateManager sm, AbstractMemberMetaData mmd)
Constructor, using StateManager of the "owner" and the field name.- Parameters:
sm
- The owner StateManagermmd
- Metadata for the member
-
-
Method Detail
-
initialise
public void initialise(Set<E> newValue, Object oldValue)
Description copied from interface:SCO
Method to initialise the SCO for use, where replacing an old value with a new value such as when calling a setter field passing in a new value. Note that oldValue is marked as Object since for cases where the member type is Collection the newValue could be, for example, ArrayList, and the oldValue of type Collection (representing null).- Specified by:
initialise
in interfaceSCO<E>
- Parameters:
newValue
- New value (to wrap)oldValue
- Old value (to use in deciding what needs deleting etc)
-
initialise
public void initialise(Set c)
Description copied from interface:SCO
Method to initialise the SCO for use with the provided initial value. This is used, for example, when retrieving the field from the datastore and setting it in the persistable object.- Specified by:
initialise
in interfaceSCO<E>
- Parameters:
c
- the object from which to copy the value.
-
initialise
public void initialise()
Description copied from interface:SCO
Method to initialise the SCO for use, and allowing the SCO to be loaded from the datastore (when we have a backing store). This can be utilised to perform any eager loading of information from the datastore.- Specified by:
initialise
in interfaceSCO<E>
-
setValue
public void setValue(Set<E> value)
Description copied from interface:SCOContainer
Method to change the delegate value this wraps (to save recreating the wrapper).- Specified by:
setValue
in interfaceSCOContainer<E>
- Parameters:
value
- The new value
-
load
public void load()
Method to effect the load of the data in the SCO. Used when the SCO supports lazy-loading to tell it to load all now.- Specified by:
load
in interfaceSCOContainer<E>
-
isLoaded
public boolean isLoaded()
Method to return if the SCO has its contents loaded. Returns true.- Specified by:
isLoaded
in interfaceSCOContainer<E>
- Returns:
- Whether it is loaded
-
updateEmbeddedElement
public void updateEmbeddedElement(E element, int fieldNumber, Object value, boolean makeDirty)
Method to update an embedded element in this collection.- Specified by:
updateEmbeddedElement
in interfaceSCOCollection<Set<E>,E>
- Parameters:
element
- The elementfieldNumber
- Number of field in the elementvalue
- New value for this fieldmakeDirty
- Whether to make the SCO field dirty.
-
getFieldName
public String getFieldName()
Accessor for the field name.- Specified by:
getFieldName
in interfaceSCO<E>
- Returns:
- The field name
-
getOwner
public Object getOwner()
Accessor for the owner object.
-
unsetOwner
public void unsetOwner()
Method to unset the owner and field information.- Specified by:
unsetOwner
in interfaceSCO<E>
-
makeDirty
public void makeDirty()
Utility to mark the object as dirty
-
detachCopy
public Set detachCopy(FetchPlanState state)
Method to return a detached copy of the container. Recurses through the elements so that they are likewise detached.- Specified by:
detachCopy
in interfaceSCO<E>
- Parameters:
state
- State for detachment process- Returns:
- The detached container
-
attachCopy
public void attachCopy(Set value)
Method to return an attached copy of the passed (detached) value. The returned attached copy is a SCO wrapper. Goes through the existing elements in the store for this owner field and removes ones no longer present, and adds new elements. All elements in the (detached) value are attached.- Specified by:
attachCopy
in interfaceSCO<E>
- Parameters:
value
- The new (collection) value
-
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 persistable objects. In contrast to Object.clone(), this method must not throw a CloneNotSupportedException.
-
contains
public boolean contains(Object element)
Accessor for whether an element is contained in the Collection.- Specified by:
contains
in interfaceCollection<E>
- Specified by:
contains
in interfaceSet<E>
- Overrides:
contains
in classAbstractCollection<E>
- Parameters:
element
- The element- Returns:
- Whether the element is contained here
-
containsAll
public boolean containsAll(Collection c)
Accessor for whether a collection of elements are contained here.- Specified by:
containsAll
in interfaceCollection<E>
- Specified by:
containsAll
in interfaceSet<E>
- Overrides:
containsAll
in classAbstractCollection<E>
- Parameters:
c
- The collection of elements.- Returns:
- Whether they are contained.
-
equals
public boolean equals(Object o)
Equality operator.- Specified by:
equals
in interfaceCollection<E>
- Specified by:
equals
in interfaceSet<E>
- Overrides:
equals
in classAbstractSet<E>
- Parameters:
o
- The object to compare against.- Returns:
- Whether this object is the same.
-
hashCode
public int hashCode()
Hashcode operator.- Specified by:
hashCode
in interfaceCollection<E>
- Specified by:
hashCode
in interfaceSet<E>
- Overrides:
hashCode
in classAbstractSet<E>
- Returns:
- The Hash code.
-
isEmpty
public boolean isEmpty()
Accessor for whether the Collection is empty.- Specified by:
isEmpty
in interfaceCollection<E>
- Specified by:
isEmpty
in interfaceSet<E>
- Overrides:
isEmpty
in classAbstractCollection<E>
- Returns:
- Whether it is empty.
-
size
public int size()
Accessor for the size of the Collection.- Specified by:
size
in interfaceCollection<E>
- Specified by:
size
in interfaceSet<E>
- Specified by:
size
in classAbstractCollection<E>
- Returns:
- The size
-
toArray
public Object[] toArray()
Method to return the Collection as an array.- Specified by:
toArray
in interfaceCollection<E>
- Specified by:
toArray
in interfaceSet<E>
- Overrides:
toArray
in classAbstractCollection<E>
- Returns:
- The array
-
toArray
public <T> T[] toArray(T[] a)
Method to return the Collection as an array.- Specified by:
toArray
in interfaceCollection<E>
- Specified by:
toArray
in interfaceSet<E>
- Overrides:
toArray
in classAbstractCollection<E>
- Parameters:
a
- The array to write the results to- Returns:
- The array
-
add
public boolean add(E element)
Method to add an element to the Collection.- Specified by:
add
in interfaceCollection<E>
- Specified by:
add
in interfaceSet<E>
- Overrides:
add
in classAbstractCollection<E>
- Parameters:
element
- The element to add- Returns:
- Whether it was added successfully.
-
addAll
public boolean addAll(Collection<? extends E> elements)
Method to add a collection of elements.- Specified by:
addAll
in interfaceCollection<E>
- Specified by:
addAll
in interfaceSet<E>
- Overrides:
addAll
in classAbstractCollection<E>
- Parameters:
elements
- The collection of elements to add.- Returns:
- Whether they were added successfully.
-
clear
public void clear()
Method to clear the Collection.- Specified by:
clear
in interfaceCollection<E>
- Specified by:
clear
in interfaceSet<E>
- Overrides:
clear
in classAbstractCollection<E>
-
remove
public boolean remove(Object element)
Method to remove an element from the List- Specified by:
remove
in interfaceCollection<E>
- Specified by:
remove
in interfaceSet<E>
- Overrides:
remove
in classAbstractCollection<E>
- Parameters:
element
- The Element to remove- Returns:
- Whether it was removed successfully.
-
remove
public boolean remove(Object element, boolean allowCascadeDelete)
Method to remove an element from the List- Specified by:
remove
in interfaceSCOCollection<Set<E>,E>
- Parameters:
element
- The Element to removeallowCascadeDelete
- Whether to allow cascade delete- Returns:
- Whether it was removed successfully.
-
removeAll
public boolean removeAll(Collection elements)
Method to remove a Collection of elements.- Specified by:
removeAll
in interfaceCollection<E>
- Specified by:
removeAll
in interfaceSet<E>
- Overrides:
removeAll
in classAbstractSet<E>
- Parameters:
elements
- The collection to remove- Returns:
- Whether they were removed successfully.
-
retainAll
public boolean retainAll(Collection c)
Method to retain a Collection of elements (and remove all others).- Specified by:
retainAll
in interfaceCollection<E>
- Specified by:
retainAll
in interfaceSet<E>
- Overrides:
retainAll
in classAbstractCollection<E>
- Parameters:
c
- The collection to retain- Returns:
- Whether they were retained successfully.
-
writeReplace
protected Object writeReplace() throws ObjectStreamException
The writeReplace method is called when ObjectOutputStream is preparing to write the object to the stream. The ObjectOutputStream checks whether the class defines the writeReplace method. If the method is defined, the writeReplace method is called to allow the object to designate its replacement in the stream. The object returned should be either of the same type as the object passed in or an object that when read and resolved will result in an object of a type that is compatible with all references to the object.- Returns:
- the replaced object
- Throws:
ObjectStreamException
- if an error occurs
-
stream
public Stream stream()
- Specified by:
stream
in interfaceCollection<E>
-
parallelStream
public Stream parallelStream()
- Specified by:
parallelStream
in interfaceCollection<E>
-
spliterator
public Spliterator spliterator()
- Specified by:
spliterator
in interfaceCollection<E>
- Specified by:
spliterator
in interfaceIterable<E>
- Specified by:
spliterator
in interfaceSet<E>
-
-