Package org.opensearch.painless.spi

Class WhitelistField

  • public class WhitelistField
extends java.lang.Object
    Field represents the equivalent of a Java field available as an allowlisted class field within Painless. Fields for Painless classes may be accessed exactly as fields for Java classes are using the '.' operator on an existing class variable/field.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      java.lang.String canonicalTypeNameParameter
      The canonical type name for the field which can be used to look up the Java field through reflection.
      java.lang.String fieldName
      The field name used to look up the field reflection object.
      java.lang.String origin
      Information about where this method was allowlisted from.
      java.util.Map<java.lang.Class<?>,​java.lang.Object> painlessAnnotations
      The Map of annotations for this field.

    • Constructor Summary

      Constructors 
      Constructor Description
      WhitelistField​(java.lang.String origin, java.lang.String fieldName, java.lang.String canonicalTypeNameParameter, java.util.List<java.lang.Object> painlessAnnotations)
      Standard constructor.

    • Method Summary

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • origin

        public final java.lang.String origin
        Information about where this method was allowlisted from.

      • fieldName

        public final java.lang.String fieldName
        The field name used to look up the field reflection object.

      • canonicalTypeNameParameter

        public final java.lang.String canonicalTypeNameParameter
        The canonical type name for the field which can be used to look up the Java field through reflection.

      • painlessAnnotations

        public final java.util.Map<java.lang.Class<?>,​java.lang.Object> painlessAnnotations
        The Map of annotations for this field.

    • Constructor Detail

      • WhitelistField

        public WhitelistField​(java.lang.String origin,
                      java.lang.String fieldName,
                      java.lang.String canonicalTypeNameParameter,
                      java.util.List<java.lang.Object> painlessAnnotations)
        Standard constructor. All values must be not null.