Class AbstractDataStoreFactory

java.lang.Object

com.google.api.client.util.store.AbstractDataStoreFactory

All Implemented Interfaces:

DataStoreFactory

Direct Known Subclasses:

FileDataStoreFactory, MemoryDataStoreFactory

public abstract class AbstractDataStoreFactory
extends Object
implements DataStoreFactory

Abstract data store factory implementation.

Since:

1.16

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<String, DataStore<? extends Serializable>>	dataStoreMap	Map of data store ID to data store.
private static final Pattern	ID_PATTERN	Pattern to control possible values for the id parameter of getDataStore(String).
private final Lock	lock	Lock on access to the data store map.

Constructor Summary

Constructors

Constructor	Description
AbstractDataStoreFactory()

Method Summary

Modifier and Type	Method	Description
protected abstract <V extends Serializable> DataStore<V>	createDataStore(String id)	Returns a new instance of a type-specific data store based on the given unique ID.
final <V extends Serializable> DataStore<V>	getDataStore(String id)	Returns a type-specific data store based on the given unique ID.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

lock

private final Lock lock

Lock on access to the data store map.

dataStoreMap

private final Map<String, DataStore<? extends Serializable>> dataStoreMap

Map of data store ID to data store.

ID_PATTERN

private static final Pattern ID_PATTERN

Pattern to control possible values for the id parameter of getDataStore(String).

Constructor Details

AbstractDataStoreFactory

public AbstractDataStoreFactory()

Method Details

getDataStore

public final <V extends Serializable> DataStore<V> getDataStore(String id)
                                                         throws IOException

Description copied from interface: DataStoreFactory

Returns a type-specific data store based on the given unique ID.

If a data store by that ID does not already exist, it should be created now, stored for later access, and returned. Otherwise, if there is already a data store by that ID, it should be returned. The DataStore.getId() must match the id parameter from this method.

The ID must be at least 1 and at most 30 characters long, and must contain only alphanumeric or underscore characters.

Specified by:

getDataStore in interface DataStoreFactory

Type Parameters:

V - serializable type of the mapped value

Parameters:

id - unique ID to refer to typed data store

Throws:

IOException

createDataStore

protected abstract <V extends Serializable>
DataStore<V> createDataStore(String id)
                      throws IOException

Returns a new instance of a type-specific data store based on the given unique ID.

The DataStore.getId() must match the id parameter from this method.

Type Parameters:

V - serializable type of the mapped value

Parameters:

id - unique ID to refer to typed data store

Throws:

IOException