org.gonn.gava

Interface Storable<T,U>

Type Parameters:

T - data type for Key

U - data type for Record (value)

All Known Implementing Classes:

Config

public interface Storable<T,U>

Minimal Database Interface for CRUD operation A user can use key for Bucket/Database as well. (eg. "employees.Gon") public class ABC implements Storable <String, String> { ... }

Version:

1.0.1

Author:

Gon Yi

Method Summary

Modifier and Type	Method and Description
default <E extends Exception> void	close() Close database connection.
<E extends Exception> boolean	delete(T key) Delete a record
<E extends Exception> U	get(T key) Get a record for the key.
<E extends Exception> void	set(T key, U rec) Add a record with the key.
default <E extends Exception> boolean	update(T key, UnaryOperator<U> fUpdate) Update a record

Method Detail

get

<E extends Exception> U get(T key)
                     throws E extends Exception

Get a record for the key.

Type Parameters:

E - any exception

Parameters:

key - to the record

Returns:

record IF exists OTHERWISE returns null.

Throws:

E - any exception

E extends Exception

set

<E extends Exception> void set(T key,
                               U rec)
                        throws E extends Exception

Add a record with the key. IF the key already exists, overwrite the record.

Type Parameters:

E - any exception

Parameters:

key - to the record.

rec - to save.

Throws:

E - any exception

E extends Exception

delete

<E extends Exception> boolean delete(T key)
                              throws E extends Exception

Delete a record

Type Parameters:

E - any exception

Parameters:

key - to the record

Returns:

true if a record exists and deleted, otherwise false.

Throws:

E - any exception

E extends Exception

update

default <E extends Exception> boolean update(T key,
                                             UnaryOperator<U> fUpdate)
                                      throws E extends Exception

Update a record

Type Parameters:

E - any exception

Parameters:

key - to the record

fUpdate - function to update the record. e.g. f(currentRecord) returns newRecord.

Returns:

true IF a record exists, OTHERWISE, false.

Throws:

E - any exception

E extends Exception

close

default <E extends Exception> void close()
                                  throws E extends Exception

Close database connection.

Type Parameters:

E - any exception

Throws:

E - any exception

E extends Exception