com.gluonhq.connect.provider

Interface ObjectDataRemover<T>

Type Parameters:

T - the type of the object to remove

public interface ObjectDataRemover<T>

An ObjectDataRemover is an entity that has the ability to remove an object. The actual source and method that are used for removing the object is completely up to the implementation. The most common scenario is that the remover uses an OutputDataSource that is able to remove the object that the source points to.

Method Summary

Modifier and Type	Method and Description
java.util.Optional<T>	removeObject(GluonObservableObject<T> observable) Removes the object and optionally returns an object.

Method Detail

removeObject

java.util.Optional<T> removeObject(GluonObservableObject<T> observable)
                            throws java.io.IOException

Removes the object and optionally returns an object. The actual method that removes the object is completely left to the implementation. This method is called by DataProvider.removeObject(GluonObservableObject, ObjectDataRemover) to initiate the actual removal process. If this method returns a non-empty Optional, the object that is contained in the Optional will be set on the provided observable object. Otherwise, the value of the observable object will be set to null. When the remove operation completed successfully, the state of the provided observable will be set to ConnectState.REMOVED.

Parameters:

observable - the observable object that needs to be removed

Returns:

an optional containing an object that will ultimately be set on the provided GluonObservableObject

Throws:

java.io.IOException - when an exception occurred during the removal process