dev.cel.common.values.StructValue Maven / Gradle / Ivy

Go to download
// Copyright 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package dev.cel.common.values;

import com.google.errorprone.annotations.Immutable;

/**
 * StructValue is a representation of a structured object with typed properties.
 *
 * Users may extend from this class to provide a custom struct that CEL can understand (ex:
 * POJOs). Custom struct implementations must provide all functionalities denoted in the CEL
 * specification, such as field selection, presence testing and new object creation.
 *
 * For an expression `e` selecting a field `f`, `e.f` must throw an exception if `f` does not
 * exist in the struct (i.e: hasField returns false). If the field exists but is not set, the
 * implementation should return an appropriate default value based on the struct's semantics.
 */
@Immutable
public abstract class StructValue extends CelValue
    implements SelectableValue {}