Package dev.cel.common

Class CelSource

java.lang.Object

dev.cel.common.CelSource

@Immutable
public final class CelSource
extends java.lang.Object

Represents the source content of an expression and related metadata.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CelSource.Builder	Builder for CelSource.
static class	CelSource.Extension	Tag for an extension that were used while parsing or type checking the source expression.

Method Summary

Modifier and Type	Method	Description
CelCodePointArray	getContent()
java.lang.String	getDescription()
com.google.common.collect.ImmutableSet<CelSource.Extension>	getExtensions()
com.google.common.collect.ImmutableList<java.lang.Integer>	getLineOffsets()	Get the code point offsets (NOT code unit offsets) for new line characters '\n' within the source expression text.
java.util.Optional<java.lang.Integer>	getLocationOffset(int line, int column)	Get the code point offset within the source expression text that corresponds with the line and column.
java.util.Optional<java.lang.Integer>	getLocationOffset(CelSourceLocation location)	See getLocationOffset(int, int).
com.google.common.collect.ImmutableMap<java.lang.Long,CelExpr>	getMacroCalls()
java.util.Optional<CelSourceLocation>	getOffsetLocation(int offset)	Get the line and column in the source expression text for the given code point offset.
static java.util.Optional<CelSourceLocation>	getOffsetLocationImpl(java.util.List<java.lang.Integer> lineOffsets, int offset)	Get the line and column in the source expression text for the given code point offset.
com.google.common.collect.ImmutableMap<java.lang.Long,java.lang.Integer>	getPositionsMap()
java.util.Optional<java.lang.String>	getSnippet(int line)	Get the text from the source expression that corresponds to line.
static CelSource.Builder	newBuilder()
static CelSource.Builder	newBuilder(java.lang.String text)
CelSource.Builder	toBuilder()

Methods inherited from class java.lang.Object

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

Method Detail

getContent

public CelCodePointArray getContent()

getDescription

public java.lang.String getDescription()

getPositionsMap

public com.google.common.collect.ImmutableMap<java.lang.Long,java.lang.Integer> getPositionsMap()

getLineOffsets

public com.google.common.collect.ImmutableList<java.lang.Integer> getLineOffsets()

Get the code point offsets (NOT code unit offsets) for new line characters '\n' within the source expression text.

NOTE: The indices point to the index just after the '\n' not the index of '\n' itself.

getMacroCalls

public com.google.common.collect.ImmutableMap<java.lang.Long,CelExpr> getMacroCalls()

getExtensions

public com.google.common.collect.ImmutableSet<CelSource.Extension> getExtensions()

getLocationOffset

public java.util.Optional<java.lang.Integer> getLocationOffset(CelSourceLocation location)

See getLocationOffset(int, int).

getLocationOffset

public java.util.Optional<java.lang.Integer> getLocationOffset(int line,
                                                               int column)

Get the code point offset within the source expression text that corresponds with the line and column.

Parameters:

line - the line number starting from 1

column - the column number starting from 0

getOffsetLocation

public java.util.Optional<CelSourceLocation> getOffsetLocation(int offset)

Get the line and column in the source expression text for the given code point offset.

getSnippet

public java.util.Optional<java.lang.String> getSnippet(int line)

Get the text from the source expression that corresponds to line.

Parameters:

line - the line number starting from 1.

getOffsetLocationImpl

public static java.util.Optional<CelSourceLocation> getOffsetLocationImpl(java.util.List<java.lang.Integer> lineOffsets,
                                                                          int offset)

Get the line and column in the source expression text for the given code point offset.

toBuilder

public CelSource.Builder toBuilder()

newBuilder

public static CelSource.Builder newBuilder()

newBuilder

public static CelSource.Builder newBuilder(java.lang.String text)