Package dev.cel.common.ast

Class CelExpr

java.lang.Object

dev.cel.common.ast.CelExpr

@Internal
@Immutable
public abstract class CelExpr
extends java.lang.Object

An abstract representation of a common expression.

This is the native type equivalent of Expr message in syntax.proto.

Expressions are abstractly represented as a collection of identifiers, select statements, function calls, literals, and comprehensions. All operators with the exception of the '.' operator are modelled as function calls. This makes it easy to represent new operators into the existing AST.

All references within expressions must resolve to a [Decl][] provided at type-check for an expression to be valid. A reference may either be a bare identifier `name` or a qualified identifier `google.api.name`. References may either refer to a value or a function declaration.

For example, the expression `google.api.name.startsWith('expr')` references the declaration `google.api.name` within a [Expr.Select][] expression, and the function declaration `startsWith`.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CelExpr.Builder	Builder for CelExpr.
static class	CelExpr.CelCall	A call expression, including calls to predefined functions and operators.
static class	CelExpr.CelComprehension	A comprehension expression applied to a list or map.
static class	CelExpr.CelCreateList	A list creation expression.
static class	CelExpr.CelCreateStruct	A map or message creation expression.
static class	CelExpr.CelIdent	An identifier expression.
static class	CelExpr.CelNotSet	An unset expression.
static class	CelExpr.CelSelect	A field selection expression.
static class	CelExpr.ExprKind	Denotes the kind of the expression.

Constructor Summary

Constructors

Constructor	Description
CelExpr()

Method Summary

Modifier and Type	Method	Description
CelExpr.CelCall	call()
CelExpr.CelComprehension	comprehension()
CelConstant	constant()
CelExpr.CelCreateList	createList()
CelExpr.CelCreateStruct	createStruct()
abstract CelExpr.ExprKind	exprKind()
abstract long	id()
CelExpr.CelIdent	ident()
static CelExpr.Builder	newBuilder()
static CelExpr	ofCallExpr(long id, java.util.Optional<CelExpr> targetExpr, java.lang.String function, com.google.common.collect.ImmutableList<CelExpr> arguments)
static CelExpr	ofComprehension(long id, java.lang.String iterVar, CelExpr iterRange, java.lang.String accuVar, CelExpr accuInit, CelExpr loopCondition, CelExpr loopStep, CelExpr result)
static CelExpr	ofConstantExpr(long id, CelConstant celConstant)
static CelExpr	ofCreateListExpr(long id, com.google.common.collect.ImmutableList<CelExpr> elements, com.google.common.collect.ImmutableList<java.lang.Integer> optionalIndices)
static CelExpr	ofCreateStructExpr(long id, java.lang.String messageName, com.google.common.collect.ImmutableList<CelExpr.CelCreateStruct.Entry> entries)
static CelExpr.CelCreateStruct.Entry	ofCreateStructFieldEntryExpr(long id, java.lang.String fieldKey, CelExpr value, boolean isOptionalEntry)
static CelExpr.CelCreateStruct.Entry	ofCreateStructMapEntryExpr(long id, CelExpr mapKey, CelExpr value, boolean isOptionalEntry)
static CelExpr	ofIdentExpr(long id, java.lang.String identName)
static CelExpr	ofNotSet(long id)
static CelExpr	ofSelectExpr(long id, CelExpr operandExpr, java.lang.String field, boolean isTestOnly)
CelExpr.CelSelect	select()
abstract CelExpr.Builder	toBuilder()

Methods inherited from class java.lang.Object

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

Constructor Detail

CelExpr

public CelExpr()

Method Detail

id

public abstract long id()

exprKind

public abstract CelExpr.ExprKind exprKind()

constant

public CelConstant constant()

ident

public CelExpr.CelIdent ident()

select

public CelExpr.CelSelect select()

call

public CelExpr.CelCall call()

createList

public CelExpr.CelCreateList createList()

createStruct

public CelExpr.CelCreateStruct createStruct()

comprehension

public CelExpr.CelComprehension comprehension()

toBuilder

public abstract CelExpr.Builder toBuilder()

newBuilder

public static CelExpr.Builder newBuilder()

ofNotSet

public static CelExpr ofNotSet(long id)

ofConstantExpr

public static CelExpr ofConstantExpr(long id,
                                     CelConstant celConstant)

ofIdentExpr

public static CelExpr ofIdentExpr(long id,
                                  java.lang.String identName)

ofSelectExpr

public static CelExpr ofSelectExpr(long id,
                                   CelExpr operandExpr,
                                   java.lang.String field,
                                   boolean isTestOnly)

ofCallExpr

public static CelExpr ofCallExpr(long id,
                                 java.util.Optional<CelExpr> targetExpr,
                                 java.lang.String function,
                                 com.google.common.collect.ImmutableList<CelExpr> arguments)

ofCreateListExpr

public static CelExpr ofCreateListExpr(long id,
                                       com.google.common.collect.ImmutableList<CelExpr> elements,
                                       com.google.common.collect.ImmutableList<java.lang.Integer> optionalIndices)

ofCreateStructExpr

public static CelExpr ofCreateStructExpr(long id,
                                         java.lang.String messageName,
                                         com.google.common.collect.ImmutableList<CelExpr.CelCreateStruct.Entry> entries)

ofCreateStructFieldEntryExpr

public static CelExpr.CelCreateStruct.Entry ofCreateStructFieldEntryExpr(long id,
                                                                         java.lang.String fieldKey,
                                                                         CelExpr value,
                                                                         boolean isOptionalEntry)

ofCreateStructMapEntryExpr

public static CelExpr.CelCreateStruct.Entry ofCreateStructMapEntryExpr(long id,
                                                                       CelExpr mapKey,
                                                                       CelExpr value,
                                                                       boolean isOptionalEntry)

ofComprehension

public static CelExpr ofComprehension(long id,
                                      java.lang.String iterVar,
                                      CelExpr iterRange,
                                      java.lang.String accuVar,
                                      CelExpr accuInit,
                                      CelExpr loopCondition,
                                      CelExpr loopStep,
                                      CelExpr result)