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

Record Class AllocatesConstantAnnotation

java.lang.Object
java.lang.Record
org.elasticsearch.painless.spi.annotation.AllocatesConstantAnnotation
public record AllocatesConstantAnnotation(long bytes) extends Record
Marks an allowlisted constructor or method that allocates a fixed number of bytes, charged against the per-context allocation limit before the call executes. The declared cost is the total heap allocation attributable to the call, including transitive JDK-internal allocations. Use AllocatesDynamicAnnotation when the size is argument-dependent. 0 is a valid no-op ("audited: does not allocate") and emits no pre-check; negatives are rejected at allowlist load time.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    NAME
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    AllocatesConstantAnnotation(long bytes)
    Creates an instance of a AllocatesConstantAnnotation record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    bytes()
    Returns the value of the bytes 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

    • AllocatesConstantAnnotation

      public AllocatesConstantAnnotation(long bytes)
      Creates an instance of a AllocatesConstantAnnotation record class.
      Parameters:
      bytes - the value for the bytes 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 '=='.
      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.

    • bytes

      public long bytes()
      Returns the value of the bytes record component.
      Returns:
      the value of the bytes record component