Module org.elasticsearch.painless.spi
Package org.elasticsearch.painless.spi.annotation

Record Class AugmentedAnnotation

java.lang.Object
java.lang.Record
org.elasticsearch.painless.spi.annotation.AugmentedAnnotation
public record AugmentedAnnotation(String augmentedCanonicalClassName) extends Record
Use an augmented annotation to augment a class to have available a static final field from a different class. Example: // Whitelist ... class java.lang.Integer { ... } class Augmented { int MAX_VALUE @augmented[augmented_canonical_class_name="java.lang.Integer"] int MIN_VALUE @augmented[augmented_canonical_class_name="java.lang.Integer"] } ... // Script ... long value = <some_value>; int augmented = 0; if (value < Augmented.MAX_VALUE && value > Augmented.MIN_VALUE) { augmented = (int)value; } ...

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    NAME
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    AugmentedAnnotation(String augmentedCanonicalClassName)
    Creates an instance of a AugmentedAnnotation record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    augmentedCanonicalClassName()
    Returns the value of the augmentedCanonicalClassName record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

  • Constructor Details

    • AugmentedAnnotation

      public AugmentedAnnotation(String augmentedCanonicalClassName)
      Creates an instance of a AugmentedAnnotation record class.
      Parameters:
      augmentedCanonicalClassName - the value for the augmentedCanonicalClassName record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • augmentedCanonicalClassName

      public String augmentedCanonicalClassName()
      Returns the value of the augmentedCanonicalClassName record component.
      Returns:
      the value of the augmentedCanonicalClassName record component