BrushFamilySerialization


public static class BrushFamilySerialization


Summary

Public fields

static @NonNull BrushFamilySerialization

Public methods

static final BrushFamily

Read a serialized BrushFamily from the given InputStream and parse it into a BrushFamily, returning null if parsing was not successful.

static final @NonNull BrushFamily

Read a serialized BrushFamily from the given InputStream and parse it into a BrushFamily, throwing an exception if parsing was not successful.

static final void
encode(@NonNull BrushFamily brushFamily, @NonNull OutputStream output)

Write the gzip-compressed serialized representation of the BrushFamily to the given OutputStream.

Public fields

INSTANCE

Added in 1.0.0-alpha04
public static @NonNull BrushFamilySerialization INSTANCE

Public methods

decodeOrNull

Added in 1.0.0-alpha04
public static final BrushFamily decodeOrNull(@NonNull InputStream input)

Read a serialized BrushFamily from the given InputStream and parse it into a BrushFamily, returning null if parsing was not successful. The serialized representation is gzip-compressed ink.proto.BrushFamily binary proto messages, the same as written to OutputStream by encode. Kotlin callers should use BrushFamily.Companion.decodeOrNull instead.

decodeOrThrow

Added in 1.0.0-alpha04
public static final @NonNull BrushFamily decodeOrThrow(@NonNull InputStream input)

Read a serialized BrushFamily from the given InputStream and parse it into a BrushFamily, throwing an exception if parsing was not successful. The serialized representation is gzip-compressed ink.proto.BrushFamily binary proto messages, the same as written to OutputStream by encode. Kotlin callers should use BrushFamily.Companion.decodeOrThrow instead.

encode

Added in 1.0.0-alpha04
public static final void encode(@NonNull BrushFamily brushFamily, @NonNull OutputStream output)

Write the gzip-compressed serialized representation of the BrushFamily to the given OutputStream. Kotlin callers should use BrushFamily.encode instead.