BrushFamilyExtensions

Added in 1.0.0-alpha04

public final class BrushFamilyExtensions


Summary

Public methods

static final BrushFamily
decodeOrNull(
    @NonNull BrushFamily.Companion receiver,
    @NonNull InputStream input
)

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
decodeOrThrow(
    @NonNull BrushFamily.Companion receiver,
    @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.

static final void

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

Public methods

decodeOrNull

public static final BrushFamily decodeOrNull(
    @NonNull BrushFamily.Companion receiver,
    @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 BrushFamily.encode. Java callers should use BrushFamilySerialization.decodeOrNull.

decodeOrThrow

public static final @NonNull BrushFamily decodeOrThrow(
    @NonNull BrushFamily.Companion receiver,
    @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 BrushFamily.encode. Java callers should use BrushFamilySerialization.decodeOrThrow.

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

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