public class Collection extends Collection implements BackedSCO
Modifier and Type | Field and Description |
---|---|
protected boolean |
allowNulls |
protected CollectionStore |
backingStore |
protected boolean |
isCacheLoaded |
protected boolean |
useCache |
delegate, ownerMmd, ownerOP
Constructor and Description |
---|
Collection(ObjectProvider op,
AbstractMemberMetaData mmd)
Constructor.
|
Collection(ObjectProvider ownerOP,
AbstractMemberMetaData mmd,
boolean allowNulls,
CollectionStore backingStore)
Constructor used when creating a Collection for "Map.values" with specified backing store.
|
Modifier and Type | Method and Description |
---|---|
boolean |
add(Object element)
Method to add an element to the Collection.
|
boolean |
addAll(Collection c)
Method to add a collection of elements.
|
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.
|
boolean |
equals(Object o)
Equality operator.
|
Store |
getBackingStore() |
Collection |
getValue()
Accessor for the unwrapped value that we are wrapping.
|
int |
hashCode()
Hashcode operator.
|
void |
initialise()
Method to initialise the SCO for use.
|
void |
initialise(Collection c,
boolean forInsert,
boolean forUpdate)
Method to initialise the SCO from an existing value.
|
boolean |
isEmpty()
Accessor for whether the Collection is empty.
|
boolean |
isLoaded()
Method to return if the SCO has its contents loaded.
|
Iterator |
iterator()
Accessor for an iterator for the Collection.
|
void |
load()
Method to effect the load of the data in the SCO.
|
protected void |
loadFromStore()
Method to load all elements from the "backing store" where appropriate.
|
boolean |
remove(Object element)
Method to remove an element from the Collection.
|
boolean |
remove(Object element,
boolean allowCascadeDelete)
Method to remove an element from the collection, and observe the flag for whether to allow cascade delete.
|
boolean |
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).
|
int |
size()
Accessor for the size of the Collection.
|
Object[] |
toArray()
Method to return the Collection as an array.
|
Object[] |
toArray(Object[] a)
Method to return the Collection as an array.
|
String |
toString()
Method to return the Collection as a String.
|
void |
unsetOwner()
Method to unset the owner state manager and backing store information.
|
void |
updateEmbeddedElement(Object element,
int fieldNumber,
Object value)
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.
|
attachCopy, detachCopy, getFieldName, getOwner, makeDirty
finalize, getClass, notify, notifyAll, wait, wait, wait
parallelStream, removeIf, spliterator, stream
protected transient CollectionStore backingStore
protected transient boolean allowNulls
protected transient boolean useCache
protected transient boolean isCacheLoaded
public Collection(ObjectProvider op, AbstractMemberMetaData mmd)
op
- The ObjectProvider for this collection.mmd
- Metadata for the memberpublic Collection(ObjectProvider ownerOP, AbstractMemberMetaData mmd, boolean allowNulls, CollectionStore backingStore)
ownerOP
- ObjectProvider for the owning objectmmd
- Metadata for the memberallowNulls
- Whether nulls are allowedbackingStore
- The backing storepublic void initialise(Collection c, boolean forInsert, boolean forUpdate)
initialise
in interface SCO<Collection>
initialise
in class Collection
c
- The object to set fromforInsert
- Whether the object needs inserting in the datastore with this valueforUpdate
- Whether to update the object in the datastore with this valuepublic void initialise()
initialise
in interface SCO<Collection>
initialise
in class Collection
public Collection getValue()
getValue
in interface SCO<Collection>
getValue
in class Collection
public void load()
load
in interface SCOContainer<Collection>
load
in class Collection
public boolean isLoaded()
isLoaded
in interface SCOContainer<Collection>
isLoaded
in class Collection
protected void loadFromStore()
public Store getBackingStore()
getBackingStore
in interface BackedSCO
public void updateEmbeddedElement(Object element, int fieldNumber, Object value)
updateEmbeddedElement
in interface SCOCollection<Collection>
updateEmbeddedElement
in class Collection
element
- The elementfieldNumber
- Number of field in the elementvalue
- New value for this fieldpublic void unsetOwner()
unsetOwner
in interface SCO<Collection>
unsetOwner
in class Collection
public Object clone()
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.
clone
in interface SCO<Collection>
clone
in class Collection
public boolean contains(Object element)
contains
in interface Collection
contains
in class Collection
element
- The elementpublic boolean containsAll(Collection c)
containsAll
in interface Collection
containsAll
in class Collection
c
- The collection of elements.public boolean equals(Object o)
equals
in interface Collection
equals
in class Collection
o
- The object to compare against.public int hashCode()
hashCode
in interface Collection
hashCode
in class Collection
public boolean isEmpty()
isEmpty
in interface Collection
isEmpty
in class Collection
public Iterator iterator()
iterator
in interface Iterable
iterator
in interface Collection
iterator
in class Collection
public int size()
size
in interface Collection
size
in class Collection
public Object[] toArray()
toArray
in interface Collection
toArray
in class Collection
public Object[] toArray(Object[] a)
toArray
in interface Collection
toArray
in class Collection
a
- The array to write the results topublic String toString()
toString
in class AbstractCollection
public boolean add(Object element)
add
in interface Collection
add
in class Collection
element
- The element to addpublic boolean addAll(Collection c)
addAll
in interface Collection
addAll
in class Collection
c
- The collection of elements to add.public void clear()
clear
in interface Collection
clear
in class Collection
public boolean remove(Object element)
remove
in interface Collection
remove
in class Collection
element
- The Element to removepublic boolean remove(Object element, boolean allowCascadeDelete)
remove
in interface SCOCollection<Collection>
remove
in class Collection
element
- The elementallowCascadeDelete
- Whether to allow cascade deletepublic boolean removeAll(Collection elements)
removeAll
in interface Collection
removeAll
in class Collection
elements
- The collection to removepublic boolean retainAll(Collection c)
retainAll
in interface Collection
retainAll
in class Collection
c
- The collection to retainprotected Object writeReplace() throws ObjectStreamException
writeReplace
in class Collection
ObjectStreamException
- if an error occursCopyright © 2015. All rights reserved.