org.opendaylight.yangtools.util

Class OptionalBoolean

java.lang.Object

org.opendaylight.yangtools.util.OptionalBoolean

@Beta
public final class OptionalBoolean
extends Object

Utility class for storing an optional boolean in a single byte value. This cuts down the memory requirement quite at very small computational cost.

Note: fields do not have to be explicitly initialized, as default initialization value for 'byte', 0, is used to represent 'absent' condition.

Author:

Robert Varga

Method Summary

Modifier and Type	Method and Description
static boolean	get(byte value) Decode boolean from a field value, just like Optional.get().
static boolean	isPresent(byte value) Check if a field value has been set, just like Optional.isPresent().
static byte	of(boolean bool) Encode a boolean to a field value, just like Optional.of(Object).
static byte	ofNullable(@Nullable Boolean bool) Convert a nullable Boolean into a field value, just like Optional.ofNullable(Object).
static byte	ofOptional(Optional<Boolean> value) Convert an Optional Boolean into a field value.
static @Nullable Boolean	toNullable(byte value) Convert a field value to a nullable Boolean.
static @NonNull Optional<Boolean>	toOptional(byte value) Convert a field value into an Optional Boolean.
static @NonNull String	toString(byte value) Convert a field value into a String representation.

Methods inherited from class java.lang.Object

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

Method Detail

isPresent

public static boolean isPresent(byte value)

Check if a field value has been set, just like Optional.isPresent().

Parameters:

value - field value

Returns:

True if the value is set.

Throws:

IllegalArgumentException - if value is invalid

get

public static boolean get(byte value)

Decode boolean from a field value, just like Optional.get().

Parameters:

value - Field value

Returns:

Decoded boolean.

Throws:

IllegalArgumentException - if value is invalid

IllegalStateException - if value has not been set

of

public static byte of(boolean bool)

Encode a boolean to a field value, just like Optional.of(Object).

Parameters:

bool - Boolean value.

Returns:

Field value.

ofNullable

public static byte ofNullable(@Nullable Boolean bool)

Convert a nullable Boolean into a field value, just like Optional.ofNullable(Object).

Parameters:

bool - Boolean value.

Returns:

Field value.

toNullable

public static @Nullable Boolean toNullable(byte value)

Convert a field value to a nullable Boolean. Similar to Optional.orElse(null).

Parameters:

value - Field value.

Returns:

Nullable Boolean.

ofOptional

public static byte ofOptional(Optional<Boolean> value)

Convert an Optional Boolean into a field value.

Parameters:

value - Optional Boolean.

Returns:

Field value.

Throws:

NullPointerException - if value is null.

toOptional

public static @NonNull Optional<Boolean> toOptional(byte value)

Convert a field value into an Optional Boolean.

Parameters:

value - Field value.

Returns:

Optional Boolean.

Throws:

IllegalArgumentException - if value is invalid.

toString

public static @NonNull String toString(byte value)

Convert a field value into a String representation.

Parameters:

value - Field value.

Returns:

Boolean-compatible string, or "absent".

Throws:

IllegalArgumentException - if value is invalid.