com.vaadin.server

Class KeyMapper<V>

java.lang.Object

com.vaadin.server.KeyMapper<V>

All Implemented Interfaces:

DataKeyMapper<V>, Serializable

public class KeyMapper<V>
extends Object
implements DataKeyMapper<V>, Serializable

KeyMapper is the simple two-way map for generating textual keys for objects and retrieving the objects later with the key.

Since:

3.0

Author:

Vaadin Ltd.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
KeyMapper()

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(String key) Checks if the given key is mapped to an object.
V	get(String key) Retrieves object with the key.
String	key(V o) Gets key for an object.
void	refresh(V dataObject, ValueProvider<V,Object> identifierGetter) Updates any existing mappings of given data object.
void	remove(V removeobj) Removes object from the mapper.
void	removeAll() Removes all objects from the mapper.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyMapper

public KeyMapper()

Method Detail

key

public String key(V o)

Gets key for an object.

Specified by:

key in interface DataKeyMapper<V>

Parameters:

o - the object.

Returns:

key for given data object

get

public V get(String key)

Retrieves object with the key.

Specified by:

get in interface DataKeyMapper<V>

Parameters:

key - the name with the desired value.

Returns:

the object with the key.

remove

public void remove(V removeobj)

Removes object from the mapper.

Specified by:

remove in interface DataKeyMapper<V>

Parameters:

removeobj - the object to be removed.

removeAll

public void removeAll()

Removes all objects from the mapper.

Specified by:

removeAll in interface DataKeyMapper<V>

containsKey

public boolean containsKey(String key)

Checks if the given key is mapped to an object.

Parameters:

key - the key to check

Returns:

true if the key is currently mapped, false otherwise

Since:

7.7

refresh

public void refresh(V dataObject,
                    ValueProvider<V,Object> identifierGetter)

Description copied from interface: DataKeyMapper

Updates any existing mappings of given data object. The equality of two data objects is determined by the equality of their identifiers provided by the given value provider.

Specified by:

refresh in interface DataKeyMapper<V>

Parameters:

dataObject - the data object to update

identifierGetter - the function to get an identifier from a data object