Package org.opensearch.painless.spi

Class WhitelistField

java.lang.Object

org.opensearch.painless.spi.WhitelistField

public class WhitelistField
extends 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
final String	canonicalTypeNameParameter	The canonical type name for the field which can be used to look up the Java field through reflection.
final String	fieldName	The field name used to look up the field reflection object.
final String	origin	Information about where this method was allowlisted from.
final Map<Class<?>,Object>	painlessAnnotations	The Map of annotations for this field.

Constructor Summary

Constructors

Constructor	Description
WhitelistField(String origin, String fieldName, String canonicalTypeNameParameter, List<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 Details

origin

public final String origin

Information about where this method was allowlisted from.

fieldName

public final String fieldName

The field name used to look up the field reflection object.

canonicalTypeNameParameter

public final String canonicalTypeNameParameter

The canonical type name for the field which can be used to look up the Java field through reflection.

painlessAnnotations

public final Map<Class<?>,Object> painlessAnnotations

The Map of annotations for this field.

Constructor Details

WhitelistField

public WhitelistField(String origin,
 String fieldName,
 String canonicalTypeNameParameter,
 List<Object> painlessAnnotations)

Standard constructor. All values must be not null.