Package io.deephaven.enterprise.codec

Class StringArrayCodec

java.lang.Object

io.deephaven.enterprise.codec.StringArrayCodec

All Implemented Interfaces:

io.deephaven.util.codec.ObjectCodec<String[]>, io.deephaven.util.codec.ObjectDecoder<String[]>

Direct Known Subclasses:

StringArrayCodec

public class StringArrayCodec
extends Object
implements io.deephaven.util.codec.ObjectCodec<String[]>

A codec to read/write String arrays. This is intended for use in loggers, listeners, and the database.

Field Summary

Fields inherited from interface io.deephaven.util.codec.ObjectDecoder

VARIABLE_WIDTH_SENTINEL

Constructor Summary

Constructors

Constructor	Description
StringArrayCodec()
StringArrayCodec(String ignored)

Method Summary

Modifier and Type	Method	Description
@Nullable String[]	decode(@org.jetbrains.annotations.NotNull byte[] input, int offset, int length)
@Nullable String[]	decode(@NotNull ByteBuffer byteBuffer)	Decode a String array from the input ByteBuffer
static @Nullable String[]	decodeStatic(@NotNull ByteBuffer byteBuffer)	Decode a String array from the input ByteBuffer
@org.jetbrains.annotations.NotNull byte[]	encode(@Nullable String[] input)
static ByteBuffer	encodeAndGet(String[] input)	Encode the input array into the internal buffer and return it.
static void	encodeInto(@Nullable String[] input, @NotNull ByteBuffer byteBuffer)	Encode the input values to the specified buffer.
int	expectedObjectWidth()
int	getPrecision()
int	getScale()
boolean	isNullable()
static @NotNull ByteBuffer	maybeGetResizedBuffer(@Nullable String[] input, @Nullable ByteBuffer origBuffer)	Inspect the input buffer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.deephaven.util.codec.ObjectDecoder

checkWidth

Constructor Details

StringArrayCodec

public StringArrayCodec()

StringArrayCodec

public StringArrayCodec(String ignored)

Method Details

encodeAndGet

public static ByteBuffer encodeAndGet(String[] input)

Encode the input array into the internal buffer and return it.

Parameters:

input - the array to encode

Returns:

a reference to the internal byte buffer

maybeGetResizedBuffer

@NotNull
public static @NotNull ByteBuffer maybeGetResizedBuffer(@Nullable
 @Nullable String[] input,
 @Nullable
 @Nullable ByteBuffer origBuffer)

Inspect the input buffer. If it is large enough to encode input, clear and return it, otherwise allocate a new buffer with an appropriate capacity and return that.

Parameters:

input - the input to encode

origBuffer - the original buffer to maybe resize.

Returns:

a properly sized byte buffer to encode input.

encodeInto

public static void encodeInto(@Nullable
 @Nullable String[] input,
 @NotNull
 @NotNull ByteBuffer byteBuffer)

Encode the input values to the specified buffer.

Parameters:

input - the input, may be null.

byteBuffer - the buffer to encode into

decode

@Nullable
public @Nullable String[] decode(@NotNull
 @NotNull ByteBuffer byteBuffer)

Decode a String array from the input ByteBuffer

Specified by:

decode in interface io.deephaven.util.codec.ObjectDecoder<String[]>

Parameters:

byteBuffer - the buffer containing the encoded String array

Returns:

the decoded string array

decodeStatic

@Nullable
public static @Nullable String[] decodeStatic(@NotNull
 @NotNull ByteBuffer byteBuffer)

Decode a String array from the input ByteBuffer

Parameters:

byteBuffer - the buffer containing the encoded String array

Returns:

the decoded string array

encode

@NotNull
public @org.jetbrains.annotations.NotNull byte[] encode(@Nullable
 @Nullable String[] input)

Specified by:

encode in interface io.deephaven.util.codec.ObjectCodec<String[]>

isNullable

public boolean isNullable()

Specified by:

isNullable in interface io.deephaven.util.codec.ObjectCodec<String[]>

getPrecision

public int getPrecision()

Specified by:

getPrecision in interface io.deephaven.util.codec.ObjectCodec<String[]>

getScale

public int getScale()

Specified by:

getScale in interface io.deephaven.util.codec.ObjectCodec<String[]>

decode

@Nullable
public @Nullable String[] decode(@NotNull
 @org.jetbrains.annotations.NotNull byte[] input,
 int offset,
 int length)

Specified by:

decode in interface io.deephaven.util.codec.ObjectDecoder<String[]>

expectedObjectWidth

public int expectedObjectWidth()

Specified by:

expectedObjectWidth in interface io.deephaven.util.codec.ObjectDecoder<String[]>