org.infinispan.persistence.keymappers.TwoWayKey2StringMapper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of infinispan-embedded

Infinispan Embedded All-in-One module

There is a newer version: 9.1.7.Final

package org.infinispan.persistence.keymappers;

/**
 * Extends {@link Key2StringMapper} and allows a bidirectional transformation between keys and Strings.  Note that the
 * object instance created by {@link #getKeyMapping(String)} is guaranteed to be equal to the original object
 * used to generate the String, but not necessarily the same object reference.
 * 
 * The following condition should be satisfied by implementations of this interface:
 * 
 *   assert key.equals(mapper.getKeyMapping(mapper.getStringMapping(key)));
 * 
 *
 * @author [email protected]
 * @author Manik Surtani
 * @since 4.1
 */
public interface TwoWayKey2StringMapper extends Key2StringMapper {
   /**
    * Maps a String back to its original key
    * @param stringKey string representation of a key
    * @return an object instance that is equal to the original object used to create the key mapping.
    */
   Object getKeyMapping(String stringKey);
}