DynamicBuilders.DynamicBool


@RequiresSchemaVersion(major = 1, minor = 200)
public interface DynamicBuilders.DynamicBool extends DynamicBuilders.DynamicType


Interface defining a dynamic boolean type.

Summary

Public methods

default @NonNull DynamicBuilders.DynamicBool
@RequiresSchemaVersion(major = 1, minor = 200)
and(@NonNull DynamicBuilders.DynamicBool input)

Returns a DynamicBool that is true if this DynamicBool and input are both true, otherwise it is false. i.e. boolean result = this && input

default static @NonNull DynamicBuilders.DynamicBool
@RequiresSchemaVersion(major = 1, minor = 200)
constant(boolean constant)

Creates a constant-valued DynamicBool.

default @NonNull DynamicBuilders.DynamicBool
@RequiresSchemaVersion(major = 1, minor = 200)
eq(@NonNull DynamicBuilders.DynamicBool other)

Returns a DynamicBool that is true if the value of this DynamicBool and other are equal, otherwise it's false.

default static @NonNull DynamicBuilders.DynamicBool
@RequiresSchemaVersion(major = 1, minor = 200)
from(
    @NonNull DynamicDataKey<DynamicBuilders.DynamicBool> dynamicDataKey
)

Creates a DynamicBool that is bound to the value of an item of the State.

default static @NonNull DynamicBuilders.DynamicBool
fromByteArray(@NonNull byte[] byteArray)

Creates a DynamicBool from a byte array generated by toDynamicBoolByteArray.

default static @NonNull DynamicBuilders.DynamicBool
fromByteArray(@NonNull byte[] byteArray, int offset, int length)

Creates a DynamicBool from the provided byte array at the provided offset and length, that was generated by one of the toDynamicBoolByteArray overloads.

default @NonNull DynamicBuilders.DynamicBool
@RequiresSchemaVersion(major = 1, minor = 200)
ne(@NonNull DynamicBuilders.DynamicBool other)

Returns a DynamicBool that is true if the value of this DynamicBool and other are not equal, otherwise it's false.

default @NonNull DynamicBuilders.DynamicBool
@RequiresSchemaVersion(major = 1, minor = 200)
negate()

Returns a DynamicBool that has the opposite value of this DynamicBool. i.e. {code result = !this}

default @NonNull DynamicBuilders.DynamicBool
@RequiresSchemaVersion(major = 1, minor = 200)
or(@NonNull DynamicBuilders.DynamicBool input)

Returns a DynamicBool that is true if this DynamicBool or input are true, otherwise it is false. i.e. boolean result = this || input

default @NonNull byte[]

Serializes the DynamicBool into a new byte array that can later be used with fromByteArray.

default int
toDynamicBoolByteArray(@NonNull byte[] byteArray)

Serializes the DynamicBool into the provided byte array, returning the amount of bytes written, that can later be used with DynamicBool.fromByteArray(byteArray, 0, bytesWritten).

default int
toDynamicBoolByteArray(@NonNull byte[] byteArray, int offset, int length)

Serializes the DynamicBool into the provided byte array, returning the amount of bytes written, limited by the provided offset and length, that can later be used with DynamicBool.fromByteArray(byteArray, offset, bytesWritten).

Public methods

and

Added in 1.0.0
@RequiresSchemaVersion(major = 1, minor = 200)
default @NonNull DynamicBuilders.DynamicBool and(@NonNull DynamicBuilders.DynamicBool input)

Returns a DynamicBool that is true if this DynamicBool and input are both true, otherwise it is false. i.e. boolean result = this && input

Parameters
@NonNull DynamicBuilders.DynamicBool input

The right hand operand of the "and" operation.

constant

Added in 1.0.0
@RequiresSchemaVersion(major = 1, minor = 200)
default static @NonNull DynamicBuilders.DynamicBool constant(boolean constant)

Creates a constant-valued DynamicBool.

eq

Added in 1.0.0
@RequiresSchemaVersion(major = 1, minor = 200)
default @NonNull DynamicBuilders.DynamicBool eq(@NonNull DynamicBuilders.DynamicBool other)

Returns a DynamicBool that is true if the value of this DynamicBool and other are equal, otherwise it's false.

from

Added in 1.0.0
@RequiresSchemaVersion(major = 1, minor = 200)
default static @NonNull DynamicBuilders.DynamicBool from(
    @NonNull DynamicDataKey<DynamicBuilders.DynamicBool> dynamicDataKey
)

Creates a DynamicBool that is bound to the value of an item of the State.

Parameters
@NonNull DynamicDataKey<DynamicBuilders.DynamicBool> dynamicDataKey

The key to a DynamicDataValue with a boolean value.

fromByteArray

Added in 1.0.0
default static @NonNull DynamicBuilders.DynamicBool fromByteArray(@NonNull byte[] byteArray)

Creates a DynamicBool from a byte array generated by toDynamicBoolByteArray.

Throws
java.lang.IllegalArgumentException

if the byte array does not contain a valid serialization

fromByteArray

Added in 1.0.0
default static @NonNull DynamicBuilders.DynamicBool fromByteArray(@NonNull byte[] byteArray, int offset, int length)

Creates a DynamicBool from the provided byte array at the provided offset and length, that was generated by one of the toDynamicBoolByteArray overloads.

Throws
java.lang.IllegalArgumentException

if the byte array does not contain a valid serialization in the provided offset and length

ne

Added in 1.0.0
@RequiresSchemaVersion(major = 1, minor = 200)
default @NonNull DynamicBuilders.DynamicBool ne(@NonNull DynamicBuilders.DynamicBool other)

Returns a DynamicBool that is true if the value of this DynamicBool and other are not equal, otherwise it's false.

negate

Added in 1.0.0
@RequiresSchemaVersion(major = 1, minor = 200)
default @NonNull DynamicBuilders.DynamicBool negate()

Returns a DynamicBool that has the opposite value of this DynamicBool. i.e. {code result = !this}

or

Added in 1.0.0
@RequiresSchemaVersion(major = 1, minor = 200)
default @NonNull DynamicBuilders.DynamicBool or(@NonNull DynamicBuilders.DynamicBool input)

Returns a DynamicBool that is true if this DynamicBool or input are true, otherwise it is false. i.e. boolean result = this || input

Parameters
@NonNull DynamicBuilders.DynamicBool input

The right hand operand of the "or" operation.

toDynamicBoolByteArray

Added in 1.0.0
default @NonNull byte[] toDynamicBoolByteArray()

Serializes the DynamicBool into a new byte array that can later be used with fromByteArray.

toDynamicBoolByteArray

Added in 1.0.0
default int toDynamicBoolByteArray(@NonNull byte[] byteArray)

Serializes the DynamicBool into the provided byte array, returning the amount of bytes written, that can later be used with DynamicBool.fromByteArray(byteArray, 0, bytesWritten).

Throws
java.lang.IllegalArgumentException

if the byte array is too small

toDynamicBoolByteArray

Added in 1.0.0
default int toDynamicBoolByteArray(@NonNull byte[] byteArray, int offset, int length)

Serializes the DynamicBool into the provided byte array, returning the amount of bytes written, limited by the provided offset and length, that can later be used with DynamicBool.fromByteArray(byteArray, offset, bytesWritten).

Throws
java.lang.IllegalArgumentException

if the byte array is too small