io.flutter.plugin.common.JSONMethodCodec Class Reference

Inheritance diagram for io.flutter.plugin.common.JSONMethodCodec:

Public Member Functions
ByteBuffer	encodeMethodCall (@NonNull MethodCall methodCall)
MethodCall	decodeMethodCall (@NonNull ByteBuffer message)
ByteBuffer	encodeSuccessEnvelope (@Nullable Object result)
ByteBuffer	encodeErrorEnvelope ( @NonNull String errorCode, @Nullable String errorMessage, @Nullable Object errorDetails)
ByteBuffer	encodeErrorEnvelopeWithStacktrace ( @NonNull String errorCode, @Nullable String errorMessage, @Nullable Object errorDetails, @Nullable String errorStacktrace)
Object	decodeEnvelope (@NonNull ByteBuffer envelope)

Static Public Attributes
static final JSONMethodCodec	INSTANCE = new JSONMethodCodec()

Package Functions
Object	unwrapNull (Object value)

Detailed Description

A MethodCodec using UTF-8 encoded JSON method calls and result envelopes.

This codec is guaranteed to be compatible with the corresponding JSONMethodCodec on the Dart side. These parts of the Flutter SDK are evolved synchronously.

Values supported as methods arguments and result payloads are those supported by JSONMessageCodec.

Definition at line 24 of file JSONMethodCodec.java.

Member Function Documentation

decodeEnvelope()

Object io.flutter.plugin.common.JSONMethodCodec.decodeEnvelope ( @NonNull ByteBuffer  envelope )

inline

Decodes a result envelope from binary.

Parameters

envelope

the binary encoding of a result envelope as a ByteBuffer.

Returns

the enveloped result Object.

Exceptions

FlutterException

if the envelope was an error envelope.

Implements io.flutter.plugin.common.MethodCodec.

Definition at line 96 of file JSONMethodCodec.java.

                                                             {
    try {
      final Object json = JSONMessageCodec.INSTANCE.decodeMessage(envelope);
      if (json instanceof JSONArray) {
        final JSONArray array = (JSONArray) json;
        if (array.length() == 1) {
          return unwrapNull(array.opt(0));
        }
        if (array.length() == 3) {
          final Object code = array.get(0);
          final Object message = unwrapNull(array.opt(1));
          final Object details = unwrapNull(array.opt(2));
          if (code instanceof String && (message == null || message instanceof String)) {
            throw new FlutterException((String) code, (String) message, details);
          }
        }
      }
      throw new IllegalArgumentException("Invalid envelope: " + json);
    } catch (JSONException e) {
      throw new IllegalArgumentException("Invalid JSON", e);
    }
  }

decodeMethodCall()

MethodCall io.flutter.plugin.common.JSONMethodCodec.decodeMethodCall ( @NonNull ByteBuffer  methodCall )

inline

Decodes a message call from binary.

Parameters

methodCall

the binary encoding of the method call as a ByteBuffer.

Returns

a MethodCall representation of the bytes between the given buffer's current position and its limit.

Implements io.flutter.plugin.common.MethodCodec.

Definition at line 45 of file JSONMethodCodec.java.

                                                                  {
    try {
      final Object json = JSONMessageCodec.INSTANCE.decodeMessage(message);
      if (json instanceof JSONObject) {
        final JSONObject map = (JSONObject) json;
        final Object method = map.get("method");
        final Object arguments = unwrapNull(map.opt("args"));
        if (method instanceof String) {
          return new MethodCall((String) method, arguments);
        }
      }
      throw new IllegalArgumentException("Invalid method call: " + json);
    } catch (JSONException e) {
      throw new IllegalArgumentException("Invalid JSON", e);
    }
  }

encodeErrorEnvelope()

ByteBuffer io.flutter.plugin.common.JSONMethodCodec.encodeErrorEnvelope ( @NonNull String  errorCode, @Nullable String  errorMessage, @Nullable Object  errorDetails  )

inline

Encodes an error result into a binary envelope message.

Parameters

errorCode	An error code String.
errorMessage	An error message String, possibly null.
errorDetails	Error details, possibly null. Consider supporting Throwable in your codec. This is the most common value passed to this field.

Returns

a ByteBuffer containing the encoding between position 0 and the current position.

Implements io.flutter.plugin.common.MethodCodec.

Definition at line 70 of file JSONMethodCodec.java.

                                                                                               {
    return JSONMessageCodec.INSTANCE.encodeMessage(
        new JSONArray()
            .put(errorCode)
            .put(JSONUtil.wrap(errorMessage))
            .put(JSONUtil.wrap(errorDetails)));
  }

encodeErrorEnvelopeWithStacktrace()

ByteBuffer io.flutter.plugin.common.JSONMethodCodec.encodeErrorEnvelopeWithStacktrace ( @NonNull String  errorCode, @Nullable String  errorMessage, @Nullable Object  errorDetails, @Nullable String  errorStacktrace  )

inline

Encodes an error result into a binary envelope message with the native stacktrace.

Parameters

errorCode	An error code String.
errorMessage	An error message String, possibly null.
errorDetails	Error details, possibly null. Consider supporting Throwable in your codec. This is the most common value passed to this field.
errorStacktrace	Platform stacktrace for the error. possibly null.

Returns

a ByteBuffer containing the encoding between position 0 and the current position.

Implements io.flutter.plugin.common.MethodCodec.

Definition at line 81 of file JSONMethodCodec.java.

                                        {
    return JSONMessageCodec.INSTANCE.encodeMessage(
        new JSONArray()
            .put(errorCode)
            .put(JSONUtil.wrap(errorMessage))
            .put(JSONUtil.wrap(errorDetails))
            .put(JSONUtil.wrap(errorStacktrace)));
  }

encodeMethodCall()

ByteBuffer io.flutter.plugin.common.JSONMethodCodec.encodeMethodCall ( @NonNull MethodCall  methodCall )

inline

Encodes a message call into binary.

Parameters

methodCall

a MethodCall.

Returns

a ByteBuffer containing the encoding between position 0 and the current position.

Implements io.flutter.plugin.common.MethodCodec.

Definition at line 32 of file JSONMethodCodec.java.

                                                                     {
    try {
      final JSONObject map = new JSONObject();
      map.put("method", methodCall.method);
      map.put("args", JSONUtil.wrap(methodCall.arguments));
      return JSONMessageCodec.INSTANCE.encodeMessage(map);
    } catch (JSONException e) {
      throw new IllegalArgumentException("Invalid JSON", e);
    }
  }

encodeSuccessEnvelope()

ByteBuffer io.flutter.plugin.common.JSONMethodCodec.encodeSuccessEnvelope ( @Nullable Object  result )

inline

Encodes a successful result into a binary envelope message.

Parameters

result

The result value, possibly null.

Returns

a ByteBuffer containing the encoding between position 0 and the current position.

Implements io.flutter.plugin.common.MethodCodec.

Definition at line 64 of file JSONMethodCodec.java.

                                                                   {
    return JSONMessageCodec.INSTANCE.encodeMessage(new JSONArray().put(JSONUtil.wrap(result)));
  }

unwrapNull()

Object io.flutter.plugin.common.JSONMethodCodec.unwrapNull ( Object  value )

inlinepackage

Definition at line 119 of file JSONMethodCodec.java.

                                  {
    return (value == JSONObject.NULL) ? null : value;
  }

Member Data Documentation

INSTANCE

final JSONMethodCodec io.flutter.plugin.common.JSONMethodCodec.INSTANCE = new JSONMethodCodec()

static

Definition at line 26 of file JSONMethodCodec.java.

---

The documentation for this class was generated from the following file:

• shell/platform/android/io/flutter/plugin/common/JSONMethodCodec.java