Package dev.cel.common.values

Class OptionalValue<E extends CelValue>

java.lang.Object

dev.cel.common.values.CelValue

dev.cel.common.values.OptionalValue<E>

All Implemented Interfaces:

SelectableValue<CelValue>

@Immutable(containerOf="E")
public abstract class OptionalValue<E extends CelValue>
extends CelValue
implements SelectableValue<CelValue>

First-class support for CEL optionals. Supports similar semantics to java.util.Optional. Also supports optional field selection and presence tests against maps and structs using the optional syntax.

Field Summary

Fields

Modifier and Type	Field	Description
static OptionalValue<CelValue>	EMPTY	Sentinel value representing an empty optional ('optional.none()' in CEL)

Constructor Summary

Constructors

Constructor	Description
OptionalValue()

Method Summary

Modifier and Type	Method	Description
OptionalType	celType()	The CelType that represents this value.
static <E extends CelValue> OptionalValue<E>	create(E value)
java.util.Optional<CelValue>	find(CelValue field)	Finds the field.
boolean	isZeroValue()	Returns true if the CelValue.value() is a zero value for its type.
CelValue	select(CelValue field)	Optional field selection on maps or structs.
E	value()	The underlying value.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final OptionalValue<CelValue> EMPTY

Sentinel value representing an empty optional ('optional.none()' in CEL)

Constructor Detail

OptionalValue

public OptionalValue()

Method Detail

value

public E value()

Description copied from class: CelValue

The underlying value. This is typically the Java native value or a derived instance of CelValue (ex: an element in lists or key/value pair in maps).

Specified by:

value in class CelValue

isZeroValue

public boolean isZeroValue()

Description copied from class: CelValue

Returns true if the CelValue.value() is a zero value for its type.

Specified by:

isZeroValue in class CelValue

celType

public OptionalType celType()

Description copied from class: CelValue

The CelType that represents this value.

Specified by:

celType in class CelValue

select

public CelValue select(CelValue field)

Optional field selection on maps or structs.

1. msg.?field -> has(msg.field) ? optional{msg.field} : optional.none()
2. map[?key] -> key in map ? optional{map[key]} : optional.none()

Specified by:

select in interface SelectableValue<E extends CelValue>

find

public java.util.Optional<CelValue> find(CelValue field)

Description copied from interface: SelectableValue

Finds the field. This will return an Optional.empty() if the field does not exist. This can be used for presence testing.

Specified by:

find in interface SelectableValue<E extends CelValue>

create

public static <E extends CelValue> OptionalValue<E> create(E value)