org.springframework.data.redis.core.convert

Class Bucket

java.lang.Object

org.springframework.data.redis.core.convert.Bucket

public class Bucket
extends Object

Bucket is the data bag for Redis hash structures to be used with RedisData.

Since:

1.7

Author:

Christoph Strobl, Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Bucket.BucketPropertyPath Value object representing a path within a Bucket.

Field Summary

Fields

Modifier and Type	Field and Description
static Charset	CHARSET Encoding used for converting Byte to and from String.

Constructor Summary

Constructors

Constructor and Description
Bucket() Creates new empty bucket

Method Summary

Modifier and Type	Method and Description
Map<String,byte[]>	asMap() Key/value pairs contained in the Bucket.
Set<Map.Entry<String,byte[]>>	entrySet() A set view of the mappings contained in this bucket.
Bucket	extract(String prefix) Extracts a bucket containing key/value pairs with the prefix.
Set<String>	extractAllKeysFor(String path) Get all the keys matching a given path.
byte[]	get(String path) Get value assigned with path.
Bucket.BucketPropertyPath	getPath() Get the Bucket.BucketPropertyPath leading to the current Bucket.
Bucket.BucketPropertyPath	getPropertyPath(String property) Get the Bucket.BucketPropertyPath for a given property within the current Bucket.
boolean	isEmpty()
Set<String>	keySet()
static Bucket	newBucketFromRawMap(Map<byte[],byte[]> source) Creates a new Bucket from a given raw map.
static Bucket	newBucketFromStringMap(Map<String,String> source) Creates a new Bucket from a given String map.
void	put(String path, byte[] value) Add String representation of property dot path with given value.
Map<byte[],byte[]>	rawMap() Get keys and values in binary format.
void	remove(String path) Remove the property at property dot path.
int	size()
String	toString()
Collection<byte[]>	values()

Methods inherited from class java.lang.Object

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

Field Detail

CHARSET

public static final Charset CHARSET

Encoding used for converting Byte to and from String.

Constructor Detail

Bucket

public Bucket()

Creates new empty bucket

Method Detail

put

public void put(String path,
                byte[] value)

Add String representation of property dot path with given value.

Parameters:

path - must not be null or String.isEmpty().

value - can be null.

remove

public void remove(String path)

Remove the property at property dot path.

Parameters:

path - must not be null or String.isEmpty().

get

@Nullable
public byte[] get(String path)

Get value assigned with path.

Parameters:

path - path must not be null or String.isEmpty().

Returns:

null if not set.

entrySet

public Set<Map.Entry<String,byte[]>> entrySet()

A set view of the mappings contained in this bucket.

Returns:

never null.

isEmpty

public boolean isEmpty()

Returns:

true when no data present in Bucket.

size

public int size()

Returns:

the number of key-value mappings of the Bucket.

values

public Collection<byte[]> values()

Returns:

never null.

keySet

public Set<String> keySet()

Returns:

never null.

asMap

public Map<String,byte[]> asMap()

Key/value pairs contained in the Bucket.

Returns:

never null.

extract

public Bucket extract(String prefix)

Extracts a bucket containing key/value pairs with the prefix.

Parameters:

prefix -

Returns:

extractAllKeysFor

public Set<String> extractAllKeysFor(String path)

Get all the keys matching a given path.

Parameters:

path - the path to look for. Can be null.

Returns:

all keys if path is or empty.

rawMap

public Map<byte[],byte[]> rawMap()

Get keys and values in binary format.

Returns:

never null.

getPath

public Bucket.BucketPropertyPath getPath()

Get the Bucket.BucketPropertyPath leading to the current Bucket.

Returns:

new instance of Bucket.BucketPropertyPath.

Since:

2.1

getPropertyPath

public Bucket.BucketPropertyPath getPropertyPath(String property)

Get the Bucket.BucketPropertyPath for a given property within the current Bucket.

Parameters:

property - the property to look up.

Returns:

new instance of Bucket.BucketPropertyPath.

Since:

2.1

newBucketFromRawMap

public static Bucket newBucketFromRawMap(Map<byte[],byte[]> source)

Creates a new Bucket from a given raw map.

Parameters:

source - can be null.

Returns:

never null.

newBucketFromStringMap

public static Bucket newBucketFromStringMap(Map<String,String> source)

Creates a new Bucket from a given String map.

Parameters:

source - can be null.

Returns:

never null.

toString

public String toString()

Overrides:

toString in class Object