Package org.opensearch.painless.spi

Class WhitelistInstanceBinding

  • public class WhitelistInstanceBinding
extends java.lang.Object
    An instance binding represents a method call that stores state. Each instance binding must provide exactly one public method name. The canonical type name parameters provided must match those of the method. The method for an instance binding will target the specified Java instance.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      java.util.List<java.lang.String> canonicalTypeNameParameters
      A List of Strings that are the Painless type names for the parameters of the constructor which can be used to look up the Java constructor through reflection.
      java.lang.String methodName
      The method name for this class binding.
      java.lang.String origin
      Information about where this constructor was allowlisted from.
      java.util.Map<java.lang.Class<?>,​java.lang.Object> painlessAnnotations
      The Map of annotations for this instance binding.
      java.lang.String returnCanonicalTypeName
      The canonical type name for the return type.
      java.lang.Object targetInstance
      The Java instance this instance binding targets.

    • Constructor Summary

      Constructors 
      Constructor Description
      WhitelistInstanceBinding​(java.lang.String origin, java.lang.Object targetInstance, java.lang.String methodName, java.lang.String returnCanonicalTypeName, java.util.List<java.lang.String> canonicalTypeNameParameters, 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 constructor was allowlisted from.

      • targetInstance

        public final java.lang.Object targetInstance
        The Java instance this instance binding targets.

      • methodName

        public final java.lang.String methodName
        The method name for this class binding.

      • returnCanonicalTypeName

        public final java.lang.String returnCanonicalTypeName
        The canonical type name for the return type.

      • canonicalTypeNameParameters

        public final java.util.List<java.lang.String> canonicalTypeNameParameters
        A List of Strings that are the Painless type names for the parameters of the constructor which can be used to look up the Java constructor through reflection.

      • painlessAnnotations

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

    • Constructor Detail

      • WhitelistInstanceBinding

        public WhitelistInstanceBinding​(java.lang.String origin,
                                java.lang.Object targetInstance,
                                java.lang.String methodName,
                                java.lang.String returnCanonicalTypeName,
                                java.util.List<java.lang.String> canonicalTypeNameParameters,
                                java.util.List<java.lang.Object> painlessAnnotations)
        Standard constructor. All values must be not null.