net.openhft.chronicle.bytes.util

Enum BinaryLengthLength

java.lang.Object

java.lang.Enum<BinaryLengthLength>

net.openhft.chronicle.bytes.util.BinaryLengthLength

All Implemented Interfaces:

Serializable, Comparable<BinaryLengthLength>

public enum BinaryLengthLength
extends Enum<BinaryLengthLength>

Enum representing different byte lengths for binary values. It provides methods to get the code associated with each byte length, to initialize a BytesOut object with the length code, and to write the length of the data into the Bytes object.

Enum Constant Summary

Enum Constants

Enum Constant and Description
LENGTH_16BIT Represents a 16-bit length encoding for binary data.
LENGTH_32BIT Represents a 32-bit length encoding for binary data.
LENGTH_8BIT Represents an 8-bit length encoding for binary data.

Method Summary

Modifier and Type	Method and Description
abstract int	code() Returns the code representing the length encoding.
abstract long	initialise(@NotNull BytesOut<?> bytes) Initialises the binary data with the appropriate length encoding.
static BinaryLengthLength	valueOf(String name) Returns the enum constant of this type with the specified name.
static BinaryLengthLength[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
abstract void	writeLength(@NotNull Bytes<?> bytes, long positionReturnedFromInitialise, long end) Writes the length of the data into the Bytes object.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LENGTH_8BIT

public static final BinaryLengthLength LENGTH_8BIT

Represents an 8-bit length encoding for binary data.

LENGTH_16BIT

public static final BinaryLengthLength LENGTH_16BIT

Represents a 16-bit length encoding for binary data.

LENGTH_32BIT

public static final BinaryLengthLength LENGTH_32BIT

Represents a 32-bit length encoding for binary data.

Method Detail

values

public static BinaryLengthLength[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BinaryLengthLength c : BinaryLengthLength.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BinaryLengthLength valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

code

public abstract int code()

Returns the code representing the length encoding.

Returns:

the length encoding code

initialise

public abstract long initialise(@NotNull
                                @NotNull BytesOut<?> bytes)

Initialises the binary data with the appropriate length encoding.

Parameters:

bytes - the output bytes to write to

Returns:

the position where the length encoding starts

writeLength

public abstract void writeLength(@NotNull
                                 @NotNull Bytes<?> bytes,
                                 long positionReturnedFromInitialise,
                                 long end)

Writes the length of the data into the Bytes object.

Parameters:

bytes - The Bytes object to write to.

positionReturnedFromInitialise - The position within the Bytes to write the length.

end - The end position of the data within the Bytes.