org.ops4j.store

Class StoreFactory

java.lang.Object

org.ops4j.store.StoreFactory

public class StoreFactory
extends Object

Factory to create one or the other type of stores. Mostly deals with the fact if you really need your own store or can live with a shared instance. (better)

Author:

Toni Menzel (toni.menzel@rebaze.com)

Field Summary

Fields

Modifier and Type	Field and Description
static String	RELATIVE_STORAGE

Constructor Summary

Constructors

Constructor and Description
StoreFactory()

Method Summary

Modifier and Type	Method and Description
static Store<InputStream>	anonymousStore() If the store must be unique, here is it.
static String	convertToHex(byte[] data) Utility to convert raw data to a hex-only charset.
static Store<InputStream>	defaultStore() Get a default store instance.
static Store<InputStream>	newStore(File path) Create a store on a disk folder exactly as specified in the parameter.
static Store<InputStream>	newStore(File path, boolean flush) Create a new store with specified values for storage location and flush-policy (be careful!).
static Store<InputStream>	sharedLocalStore() Get a fixed folder on disk as store.

Methods inherited from class java.lang.Object

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

Field Detail

RELATIVE_STORAGE

public static final String RELATIVE_STORAGE

See Also:

Constant Field Values

Constructor Detail

StoreFactory

public StoreFactory()

Method Detail

defaultStore

public static Store<InputStream> defaultStore()

Get a default store instance. If you don't know, and just need the store an input stream, use this one.

Returns:

sharedLocalStore()

sharedLocalStore

public static Store<InputStream> sharedLocalStore()

Get a fixed folder on disk as store. This way caches also survive multiple vm re-starts. Also saves disk space by just storing unique items once. Relevant folder will be: new File( System.getProperty( "java.io.tmpdir" ) + "/tb" }

Returns:

a store instance pointing to a local folder on disk.

newStore

public static Store<InputStream> newStore(File path)

Create a store on a disk folder exactly as specified in the parameter.

Parameters:

path - the path on disk. Will not be flushed.

Returns:

A ready to use store.

Since:

1.6.0

newStore

public static Store<InputStream> newStore(File path,
                                          boolean flush)

Create a new store with specified values for storage location and flush-policy (be careful!).

Parameters:

path - the path on disk. Will not be flushed.

flush - whether or not to flush the content in path (dangerous)

Returns:

A ready to use store.

Since:

1.6.0

anonymousStore

public static Store<InputStream> anonymousStore()
                                         throws IOException

If the store must be unique, here is it.

Returns:

unique storage

Throws:

IOException - in case no temp folder has been found.

convertToHex

public static String convertToHex(byte[] data)

Utility to convert raw data to a hex-only charset.

Parameters:

data - any charset data.

Returns:

a hex-only charset

Since:

1.6.0