net.endrealm.realmdrive.interfaces

Interface DriveReader

All Known Implementing Classes:

SimpleDriveReader

public interface DriveReader

Author:

johannesjumpertz This defines a drive reader object

Method Summary

Modifier and Type	Method and Description
boolean	containsObject(Query query) Does the backend contain one or more objects that can be identified through the query details
void	containsObjectAsync(Query query, Consumer<Boolean> onResult) Does the backend contain one or more objects that can be identified through the query details
List<DriveObject>	readAllObjects(Query query) Read all object instances found by the specified parameters
<T> List<T>	readAllObjects(Query query, Class<T> clazz) Read all object instances found by the specified parameters
<T> void	readAllObjects(Query query, Class<T> clazz, Consumer<List<T>> onSuccess, Consumer<Throwable> onError) Read all object instances found by the specified parameters
void	readAllObjectsAsync(Query query, Consumer<List<DriveObject>> onResult) Read all object instances found by the specified parameters
DriveObject	readObject(Query query) Read the first object instance found by the specified parameters
<T> T	readObject(Query query, Class<T> clazz) Read the first object instance found by the specified parameters
<T> void	readObjectAsync(Query query, Class<T> clazz, Consumer<T> onSuccess, Runnable onFailure, Consumer<Throwable> onError) Read the first object instance found by the specified parameters
void	readObjectAsync(Query query, Consumer<DriveObject> onSuccess, Runnable onFailure) Read the first object instance found by the specified parameters
List<DriveObject>	readPagedObjects(Query query, Pageable pageable) Read all object instances found by the specified parameters
<T> List<T>	readPagedObjects(Query query, Pageable pageable, Class<T> clazz) Read all object instances found by the specified parameters
<T> void	readPagedObjectsAsync(Query query, Pageable pageable, Class<T> clazz, Consumer<List<T>> onSuccess, Consumer<Throwable> onError) Read all object instances found by the specified parameters
void	readPagedObjectsAsync(Query query, Pageable pageable, Consumer<List<DriveObject>> onResult) Read all object instances found by the specified parameters
void	setService(DriveService service) Sets the service the reader is used by.

Method Detail

containsObject

boolean containsObject(Query query)

Does the backend contain one or more objects that can be identified through the query details

Parameters:

query - query details used to search for the objects

Returns:

one or more instances found

containsObjectAsync

void containsObjectAsync(Query query,
                         Consumer<Boolean> onResult)

Does the backend contain one or more objects that can be identified through the query details

Parameters:

query - query details used to search for the objects

onResult - invoked upon result

readObject

DriveObject readObject(Query query)

Read the first object instance found by the specified parameters

Parameters:

query - query details used to search for the objects

Returns:

first object that was found. Returns null if none is found

readObjectAsync

void readObjectAsync(Query query,
                     Consumer<DriveObject> onSuccess,
                     Runnable onFailure)

Read the first object instance found by the specified parameters

Parameters:

query - query details used to search for the objects

onSuccess - this is invoked if a result is received

onFailure - this is invoked if no result is found

readObject

<T> T readObject(Query query,
                 Class<T> clazz)
          throws ClassCastException

Read the first object instance found by the specified parameters

Type Parameters:

T - will try to convert the object into the type

Parameters:

query - query details used to search for the objects

clazz - clazz to convert the result into

Returns:

first object that was found. Returns null if none is found

Throws:

ClassCastException - thrown if found object can not be converted into T

readObjectAsync

<T> void readObjectAsync(Query query,
                         Class<T> clazz,
                         Consumer<T> onSuccess,
                         Runnable onFailure,
                         Consumer<Throwable> onError)

Read the first object instance found by the specified parameters

Type Parameters:

T - will try to convert the object into the type

Parameters:

query - query details used to search for the objects

clazz - clazz to convert the result into

onSuccess - invoked upon found result

onFailure - invoked when no result is queried

onError - called if an error occurs

readAllObjects

List<DriveObject> readAllObjects(Query query)

Read all object instances found by the specified parameters

Parameters:

query - query details used to search for the objects

Returns:

objects that were found

readAllObjectsAsync

void readAllObjectsAsync(Query query,
                         Consumer<List<DriveObject>> onResult)

Read all object instances found by the specified parameters

Parameters:

query - query details used to search for the objects

onResult - invoked upon result

readAllObjects

<T> List<T> readAllObjects(Query query,
                           Class<T> clazz)
                    throws ClassCastException

Read all object instances found by the specified parameters

Type Parameters:

T - will try to convert the objects into the type

Parameters:

query - query details used to search for the objects

clazz - clazz to convert the results into

Returns:

objects that were found

Throws:

ClassCastException - thrown if found objects can not be converted into T

readAllObjects

<T> void readAllObjects(Query query,
                        Class<T> clazz,
                        Consumer<List<T>> onSuccess,
                        Consumer<Throwable> onError)

Read all object instances found by the specified parameters

Type Parameters:

T - will try to convert the objects into the type

Parameters:

query - query details used to search for the objects

clazz - clazz to convert the results into

onSuccess - invoked upon result

onError - called when an error occurs

readPagedObjects

List<DriveObject> readPagedObjects(Query query,
                                   Pageable pageable)

Read all object instances found by the specified parameters

Parameters:

query - query details used to search for the objects

pageable - used for pagination

Returns:

objects that were found

readPagedObjectsAsync

void readPagedObjectsAsync(Query query,
                           Pageable pageable,
                           Consumer<List<DriveObject>> onResult)

Read all object instances found by the specified parameters

Parameters:

query - query details used to search for the objects

pageable - used for pagination

onResult - invoked upon result

readPagedObjects

<T> List<T> readPagedObjects(Query query,
                             Pageable pageable,
                             Class<T> clazz)
                      throws ClassCastException

Read all object instances found by the specified parameters

Type Parameters:

T - will try to convert the objects into the type

Parameters:

query - query details used to search for the objects

pageable - used for pagination

clazz - clazz to convert the results into

Returns:

objects that were found

Throws:

ClassCastException - thrown if found objects can not be converted into T

readPagedObjectsAsync

<T> void readPagedObjectsAsync(Query query,
                               Pageable pageable,
                               Class<T> clazz,
                               Consumer<List<T>> onSuccess,
                               Consumer<Throwable> onError)

Read all object instances found by the specified parameters

Type Parameters:

T - will try to convert the objects into the type

Parameters:

query - query details used to search for the objects

pageable - used for pagination

clazz - clazz to convert the results into

onSuccess - invoked upon result

onError - called when an error occurs

setService

void setService(DriveService service)

Sets the service the reader is used by.

Parameters:

service - service the reader is used by