Package com.vaadin.flow.server.communication.rpc

Interface RpcDecoder

All Superinterfaces:
Serializable
All Known Implementing Classes:
DefaultRpcDecoder, StringToEnumDecoder, StringToNumberDecoder
public interface RpcDecoder extends Serializable
Decoder of RPC method arguments (server-side methods invoked from the client-side).

The client-side argument type and the server-side argument type doesn't have to match. The decoders are applied to be able to handle arguments whose types on the server side and on the client side are different.

Each decoder is checked whether it's may be used to handle the argument value with the required server-side parameter type via the isApplicable(JsonValue, Class) method. Decoder is applied to the received value and required type if it's applicable.

For internal use only. May be renamed or removed in a future release.

Since:
1.0
Author:
Vaadin Ltd

  • Method Summary

    Modifier and Type
    Method
    Description
    <T> T
    decode(elemental.json.JsonValue value, Class<T> type)
    Decode the given value to the required type.
    boolean
    isApplicable(elemental.json.JsonValue value, Class<?> type)
    Returns true if the decoder is applicable for the given value and the required type.

  • Method Details

    • isApplicable

      boolean isApplicable(elemental.json.JsonValue value, Class<?> type)
      Returns true if the decoder is applicable for the given value and the required type.
      Parameters:
      value - the value which needs to be decoded
      type - the required type to decode
      Returns:
      true if this decoder is able to decode the value to the type, false otherwise

    • decode

      <T> T decode(elemental.json.JsonValue value, Class<T> type) throws RpcDecodeException
      Decode the given value to the required type.

      RpcDecodeException is thrown if the value cannot be converted to the type (even though the decoder is applicable for the value and the type).

      Type Parameters:
      T - the decoded value type
      Parameters:
      value - the value which needs to be decoded
      type - the required type to decode
      Returns:
      the decoded value
      Throws:
      RpcDecodeException - if the value cannot be converted to the type