io.flutter.plugin.common.StandardMethodCodec Class Reference

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

Public Member Functions
	StandardMethodCodec (@NonNull StandardMessageCodec messageCodec)
ByteBuffer	encodeMethodCall (@NonNull MethodCall methodCall)
MethodCall	decodeMethodCall (@NonNull ByteBuffer methodCall)
ByteBuffer	encodeSuccessEnvelope (@NonNull Object result)
ByteBuffer	encodeErrorEnvelope ( @NonNull String errorCode, @NonNull String errorMessage, @NonNull Object errorDetails)
ByteBuffer	encodeErrorEnvelopeWithStacktrace ( @NonNull String errorCode, @NonNull String errorMessage, @NonNull Object errorDetails, @NonNull String errorStacktrace)
Object	decodeEnvelope (@NonNull ByteBuffer envelope)
Public Member Functions inherited from io.flutter.plugin.common.MethodCodec
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)

Static Public Attributes
static final StandardMethodCodec	INSTANCE

Detailed Description

A MethodCodec using the Flutter standard binary encoding.

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

Values supported as method arguments and result payloads are those supported by StandardMessageCodec.

Definition at line 23 of file StandardMethodCodec.java.

Constructor & Destructor Documentation

StandardMethodCodec()

io.flutter.plugin.common.StandardMethodCodec.StandardMethodCodec ( @NonNull StandardMessageCodec  messageCodec )

inline

Creates a new method codec based on the specified message codec.

Definition at line 29 of file StandardMethodCodec.java.

                                                                         {
    this.messageCodec = messageCodec;
  }

Member Function Documentation

decodeEnvelope()

Object io.flutter.plugin.common.StandardMethodCodec.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 109 of file StandardMethodCodec.java.

                                                             {
    envelope.order(ByteOrder.nativeOrder());
    final byte flag = envelope.get();
    switch (flag) {
      case 0:
        {
          final Object result = messageCodec.readValue(envelope);
          if (!envelope.hasRemaining()) {
            return result;
          }
        }
        // Falls through intentionally.
      case 1:
        {
          final Object code = messageCodec.readValue(envelope);
          final Object message = messageCodec.readValue(envelope);
          final Object details = messageCodec.readValue(envelope);
          if (code instanceof String
              && (message == null || message instanceof String)
              && !envelope.hasRemaining()) {
            throw new FlutterException((String) code, (String) message, details);
          }
        }
    }
    throw new IllegalArgumentException("Envelope corrupted");
  }

decodeMethodCall()

MethodCall io.flutter.plugin.common.StandardMethodCodec.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 46 of file StandardMethodCodec.java.

                                                                     {
    methodCall.order(ByteOrder.nativeOrder());
    final Object method = messageCodec.readValue(methodCall);
    final Object arguments = messageCodec.readValue(methodCall);
    if (method instanceof String && !methodCall.hasRemaining()) {
      return new MethodCall((String) method, arguments);
    }
    throw new IllegalArgumentException("Method call corrupted");
  }

encodeErrorEnvelope()

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

inline

Definition at line 69 of file StandardMethodCodec.java.

                                                                                             {
    final ExposedByteArrayOutputStream stream = new ExposedByteArrayOutputStream();
    stream.write(1);
    messageCodec.writeValue(stream, errorCode);
    messageCodec.writeValue(stream, errorMessage);
    if (errorDetails instanceof Throwable) {
      messageCodec.writeValue(stream, Log.getStackTraceString((Throwable) errorDetails));
    } else {
      messageCodec.writeValue(stream, errorDetails);
    }
    final ByteBuffer buffer = ByteBuffer.allocateDirect(stream.size());
    buffer.put(stream.buffer(), 0, stream.size());
    return buffer;
  }

encodeErrorEnvelopeWithStacktrace()

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

inline

Definition at line 87 of file StandardMethodCodec.java.

                                       {
    final ExposedByteArrayOutputStream stream = new ExposedByteArrayOutputStream();
    stream.write(1);
    messageCodec.writeValue(stream, errorCode);
    messageCodec.writeValue(stream, errorMessage);
    if (errorDetails instanceof Throwable) {
      messageCodec.writeValue(stream, Log.getStackTraceString((Throwable) errorDetails));
    } else {
      messageCodec.writeValue(stream, errorDetails);
    }
    messageCodec.writeValue(stream, errorStacktrace);
    final ByteBuffer buffer = ByteBuffer.allocateDirect(stream.size());
    buffer.put(stream.buffer(), 0, stream.size());
    return buffer;
  }

encodeMethodCall()

ByteBuffer io.flutter.plugin.common.StandardMethodCodec.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 35 of file StandardMethodCodec.java.

                                                                     {
    final ExposedByteArrayOutputStream stream = new ExposedByteArrayOutputStream();
    messageCodec.writeValue(stream, methodCall.method);
    messageCodec.writeValue(stream, methodCall.arguments);
    final ByteBuffer buffer = ByteBuffer.allocateDirect(stream.size());
    buffer.put(stream.buffer(), 0, stream.size());
    return buffer;
  }

encodeSuccessEnvelope()

ByteBuffer io.flutter.plugin.common.StandardMethodCodec.encodeSuccessEnvelope ( @NonNull Object  result )

inline

Definition at line 58 of file StandardMethodCodec.java.

                                                                  {
    final ExposedByteArrayOutputStream stream = new ExposedByteArrayOutputStream();
    stream.write(0);
    messageCodec.writeValue(stream, result);
    final ByteBuffer buffer = ByteBuffer.allocateDirect(stream.size());
    buffer.put(stream.buffer(), 0, stream.size());
    return buffer;
  }

Member Data Documentation

INSTANCE

final StandardMethodCodec io.flutter.plugin.common.StandardMethodCodec.INSTANCE

static

Initial value:

=
      new StandardMethodCodec(StandardMessageCodec.INSTANCE)

Definition at line 24 of file StandardMethodCodec.java.

---

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

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