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

Record Class AliasAnnotation

java.lang.Object
java.lang.Record
org.elasticsearch.painless.spi.annotation.AliasAnnotation
Record Components:
alias - the other name for the class
public record AliasAnnotation(String alias) extends Record
Creates an alias in PainlessLookupBuilder for the given class. Can be used to expose an inner class without scripts and whitelists needing to scope it by the outer class. For class 
 public class Outer {
     public static class Inner {

     }
     public Inner inner() {
         return new Inner();
     }
 }
Normally scripts would need to reference Outer.Inner. With an alias annotation @alias[class="Inner"] on the class 
 class Outer$Inner @alias[class="AliasedTestInnerClass"] {
 }
Then whitelist can have Inner as the return value for inner instead of Outer.Inner 
 class Outer {
   Inner inner()
 }
And scripts refer can to Inner directly, Inner inner = Outer.inner(), instead of using the outer class to scope the type name Outer.Inner as would normally be required Outer.Inner inner = Outer.inner() Only class alias types are available.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    NAME
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    AliasAnnotation(String alias)
    Creates an instance of a AliasAnnotation record class.

  • Method Summary

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

    • AliasAnnotation

      public AliasAnnotation(String alias)
      Creates an instance of a AliasAnnotation record class.
      Parameters:
      alias - the value for the alias 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.

    • alias

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