Package dev.cel.common.types

Class CelTypes

java.lang.Object

dev.cel.common.types.CelTypes

public final class CelTypes
extends java.lang.Object

Utility class for working with Type.

Field Summary

Fields

Modifier and Type	Field	Description
static Type	ANY
static java.lang.String	ANY_MESSAGE
static Type	BOOL
static java.lang.String	BOOL_WRAPPER_MESSAGE
static Type	BYTES
static java.lang.String	BYTES_WRAPPER_MESSAGE
static Type	DOUBLE
static java.lang.String	DOUBLE_WRAPPER_MESSAGE
static Type	DURATION
static java.lang.String	DURATION_MESSAGE
static Type	DYN
static Type	ERROR
static java.lang.String	FLOAT_WRAPPER_MESSAGE
static java.lang.String	INT32_WRAPPER_MESSAGE
static Type	INT64
static java.lang.String	INT64_WRAPPER_MESSAGE
static java.lang.String	LIST_VALUE_MESSAGE
static Type	NULL_TYPE
static Type	STRING
static java.lang.String	STRING_WRAPPER_MESSAGE
static java.lang.String	STRUCT_MESSAGE
static Type	TIMESTAMP
static java.lang.String	TIMESTAMP_MESSAGE
static java.lang.String	UINT32_WRAPPER_MESSAGE
static Type	UINT64
static java.lang.String	UINT64_WRAPPER_MESSAGE
static java.lang.String	VALUE_MESSAGE

Method Summary

Modifier and Type	Method	Description
static Type	celTypeToType(CelType celType)	Converts a Protobuf type into CEL native type.
static Type	create(Type target)	Create a type Type.
static Type	create(Type.PrimitiveType type)	Create a primitive Type.
static Type	create(Type.WellKnownType type)	Create a well-known Type.
static OpaqueType	createFunctionType(CelType resultType, java.lang.Iterable<CelType> argumentTypes)	Create an abstract type with an expected result type (first argument in the parameter) and the argument types.
static Type	createList(Type elemType)	Create a list with elemType.
static Type	createMap(Type keyType, Type valueType)	Create a map with keyType and valueType.
static Type	createMessage(Descriptors.Descriptor descriptor)	Create a message Type for Descriptor.
static Type	createMessage(java.lang.String messageName)	Create a message Type for messageName.
static Type	createOptionalType(Type paramType)	Create an abstract type indicating that the parameterized type may be contained within the object.
static Type	createTypeParam(java.lang.String name)	Create a type param Type.
static Type	createWrapper(Type type)	Create a wrapper type where the input is a Type of primitive types.
static Type	createWrapper(Type.PrimitiveType primitive)	Create a wrapper type for the primitive.
static java.lang.String	format(CelType type)	Method to adapt a simple Type into a String representation.
static java.lang.String	format(Type type)	Deprecated. Use format(CelType) instead.
static java.lang.String	formatFunction(CelType resultType, java.lang.Iterable<CelType> argTypes, boolean isInstance, boolean typeParamToDyn)	Format a function signature string from the input argTypes and resultType.
static java.util.Optional<CelType>	getWellKnownCelType(java.lang.String typeName)
static boolean	isOptionalType(Type type)	Checks if the provided parameter is an optional type
static boolean	isWellKnownType(java.lang.String typeName)
static boolean	isWrapperType(java.lang.String typeName)	Checks if the fully-qualified protobuf type name is a wrapper type.
static CelType	typeToCelType(Type type)	Converts a Protobuf type to CEL native type.

Methods inherited from class java.lang.Object

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

Field Detail

ANY_MESSAGE

public static final java.lang.String ANY_MESSAGE

See Also:

Constant Field Values

DURATION_MESSAGE

public static final java.lang.String DURATION_MESSAGE

See Also:

Constant Field Values

LIST_VALUE_MESSAGE

public static final java.lang.String LIST_VALUE_MESSAGE

See Also:

Constant Field Values

STRUCT_MESSAGE

public static final java.lang.String STRUCT_MESSAGE

See Also:

Constant Field Values

TIMESTAMP_MESSAGE

public static final java.lang.String TIMESTAMP_MESSAGE

See Also:

Constant Field Values

VALUE_MESSAGE

public static final java.lang.String VALUE_MESSAGE

See Also:

Constant Field Values

BOOL_WRAPPER_MESSAGE

public static final java.lang.String BOOL_WRAPPER_MESSAGE

See Also:

Constant Field Values

BYTES_WRAPPER_MESSAGE

public static final java.lang.String BYTES_WRAPPER_MESSAGE

See Also:

Constant Field Values

DOUBLE_WRAPPER_MESSAGE

public static final java.lang.String DOUBLE_WRAPPER_MESSAGE

See Also:

Constant Field Values

FLOAT_WRAPPER_MESSAGE

public static final java.lang.String FLOAT_WRAPPER_MESSAGE

See Also:

Constant Field Values

INT32_WRAPPER_MESSAGE

public static final java.lang.String INT32_WRAPPER_MESSAGE

See Also:

Constant Field Values

INT64_WRAPPER_MESSAGE

public static final java.lang.String INT64_WRAPPER_MESSAGE

See Also:

Constant Field Values

STRING_WRAPPER_MESSAGE

public static final java.lang.String STRING_WRAPPER_MESSAGE

See Also:

Constant Field Values

UINT32_WRAPPER_MESSAGE

public static final java.lang.String UINT32_WRAPPER_MESSAGE

See Also:

Constant Field Values

UINT64_WRAPPER_MESSAGE

public static final java.lang.String UINT64_WRAPPER_MESSAGE

See Also:

Constant Field Values

ERROR

public static final Type ERROR

DYN

public static final Type DYN

NULL_TYPE

public static final Type NULL_TYPE

BOOL

public static final Type BOOL

BYTES

public static final Type BYTES

STRING

public static final Type STRING

DOUBLE

public static final Type DOUBLE

UINT64

public static final Type UINT64

INT64

public static final Type INT64

ANY

public static final Type ANY

TIMESTAMP

public static final Type TIMESTAMP

DURATION

public static final Type DURATION

Method Detail

create

public static Type create(Type.PrimitiveType type)

Create a primitive Type.

create

public static Type create(Type.WellKnownType type)

Create a well-known Type.

create

public static Type create(Type target)

Create a type Type.

createList

public static Type createList(Type elemType)

Create a list with elemType.

createMap

public static Type createMap(Type keyType,
                             Type valueType)

Create a map with keyType and valueType.

createMessage

public static Type createMessage(java.lang.String messageName)

Create a message Type for messageName.

createMessage

public static Type createMessage(Descriptors.Descriptor descriptor)

Create a message Type for Descriptor.

createTypeParam

public static Type createTypeParam(java.lang.String name)

Create a type param Type.

createWrapper

public static Type createWrapper(Type.PrimitiveType primitive)

Create a wrapper type for the primitive.

createWrapper

public static Type createWrapper(Type type)

Create a wrapper type where the input is a Type of primitive types.

isWrapperType

public static boolean isWrapperType(java.lang.String typeName)

Checks if the fully-qualified protobuf type name is a wrapper type.

createOptionalType

public static Type createOptionalType(Type paramType)

Create an abstract type indicating that the parameterized type may be contained within the object.

isOptionalType

public static boolean isOptionalType(Type type)

Checks if the provided parameter is an optional type

createFunctionType

@Internal
public static OpaqueType createFunctionType(CelType resultType,
                                            java.lang.Iterable<CelType> argumentTypes)

Create an abstract type with an expected result type (first argument in the parameter) and the argument types.

CEL Library Internals. Do Not Use.

format

@Deprecated
public static java.lang.String format(Type type)

Deprecated.

Use format(CelType) instead.

Method to adapt a simple Type into a String representation.

This method can also format global functions. See the formatFunction(dev.cel.common.types.CelType, java.lang.Iterable<dev.cel.common.types.CelType>, boolean, boolean) methods for richer control over function formatting.

format

public static java.lang.String format(CelType type)

Method to adapt a simple Type into a String representation.

This method can also format global functions. See the formatFunction(dev.cel.common.types.CelType, java.lang.Iterable<dev.cel.common.types.CelType>, boolean, boolean) methods for richer control over function formatting.

formatFunction

public static java.lang.String formatFunction(CelType resultType,
                                              java.lang.Iterable<CelType> argTypes,
                                              boolean isInstance,
                                              boolean typeParamToDyn)

Format a function signature string from the input argTypes and resultType.

When isInstance is true, the argTypes[0] type is used as the receiver type.

When resultType is null, the function signature omits the result type. This is useful for computing overload signatures.

When typeParamToDyn is true, parameterized type argument are represented as Types.DYN values.

isWellKnownType

public static boolean isWellKnownType(java.lang.String typeName)

getWellKnownCelType

public static java.util.Optional<CelType> getWellKnownCelType(java.lang.String typeName)

celTypeToType

@Internal
public static Type celTypeToType(CelType celType)

Converts a Protobuf type into CEL native type.

typeToCelType

@Internal
public static CelType typeToCelType(Type type)

Converts a Protobuf type to CEL native type.