Interface TwoWayKey2StringMapper

All Superinterfaces:
Key2StringMapper
All Known Subinterfaces:
MarshallingTwoWayKey2StringMapper
All Known Implementing Classes:
DefaultTwoWayKey2StringMapper, WrappedByteArrayOrPrimitiveMapper

public interface TwoWayKey2StringMapper extends Key2StringMapper
Extends Key2StringMapper and allows a bidirectional transformation between keys and Strings. Note that the object instance created by 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)));

Since:
4.1
Author:
Mircea.Markus@jboss.com, Manik Surtani
  • Method Details

    • getKeyMapping

      Object getKeyMapping(String stringKey)
      Maps a String back to its original key
      Parameters:
      stringKey - string representation of a key
      Returns:
      an object instance that is equal to the original object used to create the key mapping.