Module org.klojang.invoke

Package org.klojang.path

Interface KeyDeserializer

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface KeyDeserializer

Defines a mechanism for converting a path segment to a map key. A KeyDeserializer can optionally be passed to the constructor of the PathWalker class. It is needed when reading or writing to objects that are, or contain maps with a non-String key type.

Method Summary

Modifier and Type	Method	Description
Object	deserialize(Path path, int segmentIndex)	Converts the path segment at the specified index to a map key.

Method Details

deserialize

Object deserialize(Path path,
 int segmentIndex)
            throws KeyDeserializationException

Converts the path segment at the specified index to a map key. If deserialization fails in a non-fatal way, a KeyDeserializationException should be thrown. With exception suppression disabled, this exception will be converted to a PathWalkerException with error code KEY_DESERIALIZATION_FAILED. With exception suppression enabled, however, the exception will be ignored, like any of the anticipated errors in ErrorCode. The read methods will simply return null for the path in question, while the write methods will tacitly abort the attempt to set the path's value.

Parameters:

path - the path containing the segment

segmentIndex - the index of the segment

Returns:

the map key

Throws:

KeyDeserializationException - If key deserialization fails in a non-fatal way