Package io.flutter.plugin.common
Class JSONMethodCodec
java.lang.Object
io.flutter.plugin.common.JSONMethodCodec
- All Implemented Interfaces:
MethodCodec
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
.
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptiondecodeEnvelope
(ByteBuffer envelope) Decodes a result envelope from binary.decodeMethodCall
(ByteBuffer message) Decodes a message call from binary.encodeErrorEnvelope
(String errorCode, String errorMessage, Object errorDetails) Encodes an error result into a binary envelope message.encodeErrorEnvelopeWithStacktrace
(String errorCode, String errorMessage, Object errorDetails, String errorStacktrace) Encodes an error result into a binary envelope message with the native stacktrace.encodeMethodCall
(MethodCall methodCall) Encodes a message call into binary.encodeSuccessEnvelope
(Object result) Encodes a successful result into a binary envelope message.
-
Field Details
-
INSTANCE
-
-
Method Details
-
encodeMethodCall
Description copied from interface:MethodCodec
Encodes a message call into binary.- Specified by:
encodeMethodCall
in interfaceMethodCodec
- Parameters:
methodCall
- aMethodCall
.- Returns:
- a
ByteBuffer
containing the encoding between position 0 and the current position.
-
decodeMethodCall
Description copied from interface:MethodCodec
Decodes a message call from binary.- Specified by:
decodeMethodCall
in interfaceMethodCodec
- Parameters:
message
- the binary encoding of the method call as aByteBuffer
.- Returns:
- a
MethodCall
representation of the bytes between the given buffer's current position and its limit.
-
encodeSuccessEnvelope
Description copied from interface:MethodCodec
Encodes a successful result into a binary envelope message.- Specified by:
encodeSuccessEnvelope
in interfaceMethodCodec
- Parameters:
result
- The result value, possibly null.- Returns:
- a
ByteBuffer
containing the encoding between position 0 and the current position.
-
encodeErrorEnvelope
@NonNull public ByteBuffer encodeErrorEnvelope(@NonNull String errorCode, @Nullable String errorMessage, @Nullable Object errorDetails) Description copied from interface:MethodCodec
Encodes an error result into a binary envelope message.- Specified by:
encodeErrorEnvelope
in interfaceMethodCodec
- Parameters:
errorCode
- An error code String.errorMessage
- An error message String, possibly null.errorDetails
- Error details, possibly null. Consider supportingThrowable
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.
-
encodeErrorEnvelopeWithStacktrace
@NonNull public ByteBuffer encodeErrorEnvelopeWithStacktrace(@NonNull String errorCode, @Nullable String errorMessage, @Nullable Object errorDetails, @Nullable String errorStacktrace) Description copied from interface:MethodCodec
Encodes an error result into a binary envelope message with the native stacktrace.- Specified by:
encodeErrorEnvelopeWithStacktrace
in interfaceMethodCodec
- Parameters:
errorCode
- An error code String.errorMessage
- An error message String, possibly null.errorDetails
- Error details, possibly null. Consider supportingThrowable
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.
-
decodeEnvelope
Description copied from interface:MethodCodec
Decodes a result envelope from binary.- Specified by:
decodeEnvelope
in interfaceMethodCodec
- Parameters:
envelope
- the binary encoding of a result envelope as aByteBuffer
.- Returns:
- the enveloped result Object.
-