Package org.rostore.client

Class GeneralContainer<K>

java.lang.Object

org.rostore.client.GeneralContainer<K>

Type Parameters:

K - key type

public class GeneralContainer<K>
extends Object

Represents a simple rostore container.

Create this object by using the RoStoreClient.getGeneralContainer(String)

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GeneralContainer(RoStoreClient roStoreClient, String name, KeySerializer<K> keySerializer)

Method Summary

Modifier and Type	Method	Description
void	create(org.rostore.entity.media.ContainerMeta containerMeta)	Creates a new container
<V> VersionedObject<K,V>	get(K key, EnumSet<org.rostore.entity.media.RecordOption> options, Function<InputStream,V> deserializer)
<V> VersionedObject<K,V>	get(K key, Function<InputStream,V> deserializer)
String	getKeyPath(K key)
org.rostore.entity.media.ContainerMeta	getMeta()	Returns the container's metadata
String	getName()
<V> VersionedObject<K,V>	getWrapped(K key, EnumSet<org.rostore.entity.media.RecordOption> options, Function<VersionedObject<K,InputStream>,VersionedObject<K,V>> transformation)
StringKeyList	listKeys(String startWithKey, String continuationKey)	Lists the keys within the container.
VersionedObject<K,InputStream>	post(VersionedObject<K,InputStream> versionedObject)
VersionedObject<K,InputStream>	post(VersionedObject<K,InputStream> versionedObject, EnumSet<org.rostore.entity.media.RecordOption> options)
<V> VersionedObject<K,V>	post(VersionedObject<K,V> versionedObject, EnumSet<org.rostore.entity.media.RecordOption> options, Function<V,InputStream> serializer)
<V> VersionedObject<K,V>	post(VersionedObject<K,V> versionedObject, Function<V,InputStream> serializer)
void	remove()	Removes container from rostore
Boolean	removeKey(K key, long version, EnumSet<org.rostore.entity.media.RecordOption> options)
<V> VersionedObject<K,V>	update(VersionedObject<K,V> original, Function<V,V> updateFunction, Function<V,InputStream> serializer, Function<InputStream,V> deserializer)	Updates the given entity
<V> VersionedObject<K,V>	update(VersionedObject<K,V> original, KeyExpirationUpdateFunction keyExpirationUpdateFunction, Function<V,V> updateFunction, Function<V,InputStream> serializer, Function<InputStream,V> deserializer)	Updates the given entity

Methods inherited from class java.lang.Object

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

Constructor Details

GeneralContainer

protected GeneralContainer(RoStoreClient roStoreClient,
 String name,
 KeySerializer<K> keySerializer)

Method Details

remove

public void remove()

Removes container from rostore

create

public void create(org.rostore.entity.media.ContainerMeta containerMeta)

Creates a new container

Parameters:

containerMeta - container meta data

getMeta

public org.rostore.entity.media.ContainerMeta getMeta()

Returns the container's metadata

Returns:

metadata

listKeys

public StringKeyList listKeys(String startWithKey,
 String continuationKey)

Lists the keys within the container.

The list of keys can be incomplete. Check StringKeyList.isMore(), it is set to true if more entries are available. in the consequent call should be the last key from the previous call.

Keys can come unsorted.

Parameters:

startWithKey - defines the prefix for the keys

continuationKey - provides the key from the previous call

Returns:

the partial list of the keys

update

public <V> VersionedObject<K,V> update(VersionedObject<K,V> original,
 KeyExpirationUpdateFunction keyExpirationUpdateFunction,
 Function<V,V> updateFunction,
 Function<V,InputStream> serializer,
 Function<InputStream,V> deserializer)

Updates the given entity

Type Parameters:

V -

Parameters:

original - the original entity

keyExpirationUpdateFunction - function that defines the expiration of the key or null, if the update should use the expiration used in the original orbject

updateFunction - function that updates the value's object

serializer - transforms the value's object to the input stream

deserializer - transforms input stream to the value object

Returns:

an updated object

update

public <V> VersionedObject<K,V> update(VersionedObject<K,V> original,
 Function<V,V> updateFunction,
 Function<V,InputStream> serializer,
 Function<InputStream,V> deserializer)

Updates the given entity

Type Parameters:

V -

Parameters:

original - the original entity

updateFunction - function that updates the value's object

serializer - transforms the value's object to the input stream

deserializer - transforms input stream to the object

Returns:

an updated object

See Also:

• update(VersionedObject, KeyExpirationUpdateFunction, Function, Function, Function)

getKeyPath

public String getKeyPath(K key)

removeKey

public Boolean removeKey(K key,
 long version,
 EnumSet<org.rostore.entity.media.RecordOption> options)

post

public VersionedObject<K,InputStream> post(VersionedObject<K,InputStream> versionedObject,
 EnumSet<org.rostore.entity.media.RecordOption> options)

post

public VersionedObject<K,InputStream> post(VersionedObject<K,InputStream> versionedObject)

post

public <V> VersionedObject<K,V> post(VersionedObject<K,V> versionedObject,
 Function<V,InputStream> serializer)

post

public <V> VersionedObject<K,V> post(VersionedObject<K,V> versionedObject,
 EnumSet<org.rostore.entity.media.RecordOption> options,
 Function<V,InputStream> serializer)

get

public <V> VersionedObject<K,V> get(K key,
 Function<InputStream,V> deserializer)

get

public <V> VersionedObject<K,V> get(K key,
 EnumSet<org.rostore.entity.media.RecordOption> options,
 Function<InputStream,V> deserializer)

getWrapped

public <V> VersionedObject<K,V> getWrapped(K key,
 EnumSet<org.rostore.entity.media.RecordOption> options,
 Function<VersionedObject<K,InputStream>,VersionedObject<K,V>> transformation)

getName

public String getName()