ObservablePersistentSet (GraniteDS API Documentation)

java.lang.Object
- com.sun.javafx.collections.ObservableSetWrapper<E>
- - org.granite.client.javafx.persistence.collection.ObservablePersistentSet<E>

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Iterable<E>, java.util.Collection<E>, java.util.Set<E>, javafx.beans.Observable, javafx.collections.ObservableSet<E>, PersistentCollection<java.util.Set<E>>, UnsafePersistentCollection<java.util.Set<E>>
```
public class ObservablePersistentSet<E>
extends com.sun.javafx.collections.ObservableSetWrapper<E>
implements UnsafePersistentCollection<java.util.Set<E>>
```
Author:

Franck WOLFF

See Also:
Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface org.granite.client.persistence.collection.PersistentCollection
  PersistentCollection.ChangeListener<C>, PersistentCollection.InitializationCallback<C>, PersistentCollection.InitializationListener<C>, PersistentCollection.Initializer<C>

Constructor Summary

Constructors
Constructor and Description

ObservablePersistentSet(PersistentSet<E> persistentSet)

Constructors
Constructor and Description
`ObservablePersistentSet(PersistentSet<E> persistentSet)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addListener(PersistentCollection.ChangeListener<java.util.Set<E>> listener)` Register a change listener
`void`	`addListener(PersistentCollection.InitializationListener<java.util.Set<E>> listener)` Register a initialization listener
`void`	`clearDirty()` Clear the dirty state of the collection
`PersistentCollection<java.util.Set<E>>`	`clone(boolean uninitialize)` Clone a persistent collection
`void`	`dirty()` Mark the collection as dirty
`boolean`	`equals(java.lang.Object object)`
`Loader<java.util.Set<E>>`	`getLoader()` Loader for the collection
`int`	`hashCode()`
`void`	`initialize(java.util.Set<E> set, PersistentCollection.Initializer<java.util.Set<E>> initializer)` Mark the collection as initialized, called after the content is loaded
`void`	`initializing()` Mark the collection as currently initializing so next access do not trigger loading
`PersistentSet<E>`	`internalPersistentCollection()`
`boolean`	`isDirty()` Is the collection dirty ?
`java.util.Iterator<E>`	`iterator()`
`void`	`readExternal(java.io.ObjectInput in)`
`void`	`removeListener(PersistentCollection.ChangeListener<java.util.Set<E>> listener)` Unregister a change listener
`void`	`removeListener(PersistentCollection.InitializationListener<java.util.Set<E>> listener)` Unregister a initialization listener
`void`	`setLoader(Loader<java.util.Set<E>> loader)` Set a loader for the collection
`java.lang.String`	`toString()`
`void`	`uninitialize()` Unload the collection and unset its initialized state
`boolean`	`wasInitialized()` Was the collection was initialized
`void`	`withInitialized(PersistentCollection.InitializationCallback<java.util.Set<E>> callback)` Execute the specified callback after ensuring the collection has been loaded If it was not loaded, the callack is called asynchronously after loading is complete
`void`	`writeExternal(java.io.ObjectOutput out)`

Methods inherited from class com.sun.javafx.collections.ObservableSetWrapper
add, addAll, addListener, addListener, clear, contains, containsAll, isEmpty, remove, removeAll, removeListener, removeListener, retainAll, size, toArray, toArray

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ObservablePersistentSet
```
public ObservablePersistentSet(PersistentSet<E> persistentSet)
```
- Method Detail
  - iterator
```
public java.util.Iterator<E> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<E>
    
    Specified by:
    
    iterator in interface java.util.Collection<E>
    
    Specified by:
    
    iterator in interface java.util.Set<E>
    
    Overrides:
    
    iterator in class com.sun.javafx.collections.ObservableSetWrapper<E>
  - writeExternal
```
public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
```
    Specified by:
    
    writeExternal in interface java.io.Externalizable
    
    Throws:
    
    java.io.IOException
  - readExternal
```
public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
```
    Specified by:
    
    readExternal in interface java.io.Externalizable
    
    Throws:
    
    java.io.IOException
    
    java.lang.ClassNotFoundException
  - wasInitialized
```
public boolean wasInitialized()
```
    Description copied from interface: PersistentCollection
    
    Was the collection was initialized
    
    Specified by:
    
    wasInitialized in interface PersistentCollection<java.util.Set<E>>
    
    Returns:
    true if collection initialized
  - uninitialize
```
public void uninitialize()
```
    Description copied from interface: PersistentCollection
    
    Unload the collection and unset its initialized state
    
    Specified by:
    
    uninitialize in interface PersistentCollection<java.util.Set<E>>
  - initialize
```
public void initialize(java.util.Set<E> set,
              PersistentCollection.Initializer<java.util.Set<E>> initializer)
```
    Description copied from interface: PersistentCollection
    
    Mark the collection as initialized, called after the content is loaded
    
    Specified by:
    
    initialize in interface PersistentCollection<java.util.Set<E>>
  - initializing
```
public void initializing()
```
    Description copied from interface: PersistentCollection
    
    Mark the collection as currently initializing so next access do not trigger loading
    
    Specified by:
    
    initializing in interface PersistentCollection<java.util.Set<E>>
  - clone
```
public PersistentCollection<java.util.Set<E>> clone(boolean uninitialize)
```
    Description copied from interface: PersistentCollection
    
    Clone a persistent collection
    
    Specified by:
    
    clone in interface PersistentCollection<java.util.Set<E>>
    
    Parameters:
    uninitialize - true to get an uninitialized clone of a lazy collection
    
    Returns:
    cloned collection
  - getLoader
```
public Loader<java.util.Set<E>> getLoader()
```
    Description copied from interface: PersistentCollection
    
    Loader for the collection
    
    Specified by:
    
    getLoader in interface PersistentCollection<java.util.Set<E>>
    
    Returns:
    loader or null of none defined
  - setLoader
```
public void setLoader(Loader<java.util.Set<E>> loader)
```
    Description copied from interface: PersistentCollection
    
    Set a loader for the collection
    
    Specified by:
    
    setLoader in interface PersistentCollection<java.util.Set<E>>
    
    Parameters:
    loader - loader that will be called when a lazy collection is accessed
  - isDirty
```
public boolean isDirty()
```
    Description copied from interface: PersistentCollection
    
    Is the collection dirty ?
    
    Specified by:
    
    isDirty in interface PersistentCollection<java.util.Set<E>>
    
    Returns:
    true if the collection has been modified since last server sync
  - dirty
```
public void dirty()
```
    Description copied from interface: PersistentCollection
    
    Mark the collection as dirty
    
    Specified by:
    
    dirty in interface PersistentCollection<java.util.Set<E>>
  - clearDirty
```
public void clearDirty()
```
    Description copied from interface: PersistentCollection
    
    Clear the dirty state of the collection
    
    Specified by:
    
    clearDirty in interface PersistentCollection<java.util.Set<E>>
  - addListener
```
public void addListener(PersistentCollection.ChangeListener<java.util.Set<E>> listener)
```
    Description copied from interface: PersistentCollection
    
    Register a change listener
    
    Specified by:
    
    addListener in interface PersistentCollection<java.util.Set<E>>
    
    Parameters:
    listener - listener
  - removeListener
```
public void removeListener(PersistentCollection.ChangeListener<java.util.Set<E>> listener)
```
    Description copied from interface: PersistentCollection
    
    Unregister a change listener
    
    Specified by:
    
    removeListener in interface PersistentCollection<java.util.Set<E>>
    
    Parameters:
    listener - listener
  - addListener
```
public void addListener(PersistentCollection.InitializationListener<java.util.Set<E>> listener)
```
    Description copied from interface: PersistentCollection
    
    Register a initialization listener
    
    Specified by:
    
    addListener in interface PersistentCollection<java.util.Set<E>>
    
    Parameters:
    listener - listener
  - removeListener
```
public void removeListener(PersistentCollection.InitializationListener<java.util.Set<E>> listener)
```
    Description copied from interface: PersistentCollection
    
    Unregister a initialization listener
    
    Specified by:
    
    removeListener in interface PersistentCollection<java.util.Set<E>>
    
    Parameters:
    listener - listener
  - withInitialized
```
public void withInitialized(PersistentCollection.InitializationCallback<java.util.Set<E>> callback)
```
    Description copied from interface: PersistentCollection
    
    Execute the specified callback after ensuring the collection has been loaded If it was not loaded, the callack is called asynchronously after loading is complete
    
    Specified by:
    
    withInitialized in interface PersistentCollection<java.util.Set<E>>
    
    Parameters:
    callback - callback method to execute
  - internalPersistentCollection
```
public PersistentSet<E> internalPersistentCollection()
```
    Specified by:
    
    internalPersistentCollection in interface UnsafePersistentCollection<java.util.Set<E>>
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class com.sun.javafx.collections.ObservableSetWrapper<E>
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface java.util.Collection<E>
    
    Specified by:
    
    hashCode in interface java.util.Set<E>
    
    Overrides:
    
    hashCode in class com.sun.javafx.collections.ObservableSetWrapper<E>
  - equals
```
public boolean equals(java.lang.Object object)
```
    Specified by:
    
    equals in interface java.util.Collection<E>
    
    Specified by:
    
    equals in interface java.util.Set<E>
    
    Overrides:
    
    equals in class com.sun.javafx.collections.ObservableSetWrapper<E>

Class ObservablePersistentSet<E>

Nested Class Summary

Nested classes/interfaces inherited from interface org.granite.client.persistence.collection.PersistentCollection

Constructor Summary

Method Summary

Methods inherited from class com.sun.javafx.collections.ObservableSetWrapper

Methods inherited from class java.lang.Object

Constructor Detail

ObservablePersistentSet

Method Detail

iterator

writeExternal

readExternal

wasInitialized

uninitialize

initialize

initializing

clone

getLoader

setLoader

isDirty

dirty

clearDirty

addListener

removeListener

addListener

removeListener

withInitialized

internalPersistentCollection

toString

hashCode

equals