org.dizitart.no2.store

Interface NitriteMap<Key,Value>

Type Parameters:

Key - the type of key

Value - the type of value

All Superinterfaces:

MetadataAware

public interface NitriteMap<Key,Value>
extends MetadataAware

Represents a Nitrite key-value pair map. Every piece of data in a Nitrite database is stored in NitriteMap.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
Key	ceilingKey(Key key) Get the smallest key that is larger or equal to this key.
void	clear() Remove all entries in the map.
boolean	containsKey(Key key) Determines if the map contains a mapping for the specified key.
java.util.Set<java.util.Map.Entry<Key,Value>>	entrySet() Gets a Set view of the mappings contained in this map.
Key	floorKey(Key key) Get the largest key that is smaller or equal to this key.
Value	get(Key key) Gets the value mapped with the specified key or null otherwise.
java.lang.String	getName() Gets name of this map.
NitriteStore	getStore() Gets the parent NitriteStore where this map is stored.
Key	higherKey(Key key) Get the smallest key that is larger than the given key, or null if no such key exists.
boolean	isEmpty() Indicates whether the map is empty.
java.util.List<Key>	keyList() Returns the list of all keys in the map.
java.util.Set<Key>	keySet() Gets a Set view of the keys contained in this map.
Key	lowerKey(Key key) Get the largest key that is smaller than the given key, or null if no such key exists.
void	put(Key key, Value value) Associates the specified value with the specified key in this map.
Value	putIfAbsent(Key key, Value value) Add a key-value pair if it does not yet exist.
Value	remove(Key key) Removes the mapping for a key from this map if it is present.
int	size() Get the number of entries, as a integer.
long	sizeAsLong() Get the number of entries, as a long.
java.util.Collection<Value>	values() Gets a Collection view of the values contained in this map.

Methods inherited from interface org.dizitart.no2.meta.MetadataAware

getAttributes, setAttributes

Method Detail

containsKey

boolean containsKey(Key key)

Determines if the map contains a mapping for the specified key.

Parameters:

key - key whose presence in this map is to be tested

Returns:

true if this map contains a mapping for the specified key.

get

Value get(Key key)

Gets the value mapped with the specified key or null otherwise.

Parameters:

key - the key

Returns:

the value, or null if the key not found.

getStore

NitriteStore getStore()

Gets the parent NitriteStore where this map is stored.

Returns:

the store where this map is stored.

clear

void clear()

Remove all entries in the map.

getName

java.lang.String getName()

Gets name of this map.

Returns:

the name of this map.

values

java.util.Collection<Value> values()

Gets a Collection view of the values contained in this map.

Returns:

the collection view of all values in this map.

remove

Value remove(Key key)

Removes the mapping for a key from this map if it is present.

Parameters:

key - the key whose mapping is to be removed from this map.

Returns:

the value that has been removed.

keySet

java.util.Set<Key> keySet()

Gets a Set view of the keys contained in this map.

Returns:

a set view of the keys contained in this map.

put

void put(Key key,
         Value value)

Associates the specified value with the specified key in this map. If the map previously contained a mapping for the key, the old value is replaced by the specified value.

Parameters:

key - key with which the specified value is to be associated (may not be null).

value - value to be associated with the specified key (may not be null).

size

int size()

Get the number of entries, as a integer. Integer.MAX_VALUE is returned if there are more than this entries.

Returns:

the number of entries, as an integer.

sizeAsLong

long sizeAsLong()

Get the number of entries, as a long.

Returns:

the number of entries

putIfAbsent

Value putIfAbsent(Key key,
                  Value value)

Add a key-value pair if it does not yet exist.

Parameters:

key - the key (may not be null)

value - the new value

Returns:

the old value if the key existed, or null otherwise.

entrySet

java.util.Set<java.util.Map.Entry<Key,Value>> entrySet()

Gets a Set view of the mappings contained in this map.

Returns:

a set view of the mappings contained in this map.

higherKey

Key higherKey(Key key)

Get the smallest key that is larger than the given key, or null if no such key exists.

Parameters:

key - the key

Returns:

the result.

ceilingKey

Key ceilingKey(Key key)

Get the smallest key that is larger or equal to this key.

Parameters:

key - the key

Returns:

the result.

lowerKey

Key lowerKey(Key key)

Get the largest key that is smaller than the given key, or null if no such key exists.

Parameters:

key - the key

Returns:

the result.

floorKey

Key floorKey(Key key)

Get the largest key that is smaller or equal to this key.

Parameters:

key - the key

Returns:

the result.

isEmpty

boolean isEmpty()

Indicates whether the map is empty.

Returns:

true if the map is empty; false otherwise.

keyList

java.util.List<Key> keyList()

Returns the list of all keys in the map.

Returns:

list of all keys.