Package com.inductiveautomation.ignition.common.script.builtin

Class PyArgumentMap

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,​java.lang.Object>
    public class PyArgumentMap
extends java.util.HashMap<java.lang.String,​java.lang.Object>
    See Also:
    Serialized Form

    • Nested Class Summary

      • Nested classes/interfaces inherited from class java.util.AbstractMap

        java.util.AbstractMap.SimpleEntry<K extends java.lang.Object,​V extends java.lang.Object>, java.util.AbstractMap.SimpleImmutableEntry<K extends java.lang.Object,​V extends java.lang.Object>

      • Nested classes/interfaces inherited from interface java.util.Map

        java.util.Map.Entry<K extends java.lang.Object,​V extends java.lang.Object>

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object getArg​(java.lang.String name)  
      java.lang.Object getArg​(java.lang.String name, java.lang.Object defaultValue)  
      java.lang.Boolean getBooleanArg​(java.lang.String name)  
      java.lang.Boolean getBooleanArg​(java.lang.String name, java.lang.Boolean def)  
      java.util.Date getDateArg​(java.lang.String name)  
      java.util.Date getDateArg​(java.lang.String name, java.util.Date def)  
      java.lang.Double getDoubleArg​(java.lang.String name)  
      java.lang.Double getDoubleArg​(java.lang.String name, java.lang.Double def)  
      java.lang.Integer getIntArg​(java.lang.String name)  
      java.lang.Integer getIntArg​(java.lang.String name, java.lang.Integer def)  
      java.lang.Long getLongArg​(java.lang.String name)  
      java.lang.Long getLongArg​(java.lang.String name, java.lang.Long def)  
      java.lang.String getStringArg​(java.lang.String name)  
      java.lang.String getStringArg​(java.lang.String name, java.lang.String def)  
      java.lang.String[] getStringArray​(java.lang.String name)  
      static PyArgumentMap interpretPyArgs​(org.python.core.PyObject[] args, java.lang.String[] keywords, java.lang.Class<?> callingClass, java.lang.String methodName)
      Helper for scripting functions that want to use python's keyword-style function invocation.
      static PyArgumentMap interpretPyArgs​(org.python.core.PyObject[] args, java.lang.String[] keywords, java.lang.String[] expectedKeywords, java.lang.Class<?>[] expectedTypes)  

      • Methods inherited from class java.util.HashMap

        clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

      • Methods inherited from class java.util.AbstractMap

        equals, hashCode, toString

      • Methods inherited from class java.lang.Object

        finalize, getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface java.util.Map

        equals, hashCode

    • Method Detail

      • interpretPyArgs

        public static PyArgumentMap interpretPyArgs​(org.python.core.PyObject[] args,
                                            java.lang.String[] keywords,
                                            java.lang.Class<?> callingClass,
                                            java.lang.String methodName)
        Helper for scripting functions that want to use python's keyword-style function invocation. This version uses reflection to look for the @KeywordArgs annotation to find the expected params and their types.

      • interpretPyArgs

        public static PyArgumentMap interpretPyArgs​(org.python.core.PyObject[] args,
                                            java.lang.String[] keywords,
                                            java.lang.String[] expectedKeywords,
                                            java.lang.Class<?>[] expectedTypes)

      • getStringArray

        public java.lang.String[] getStringArray​(java.lang.String name)

      • getStringArg

        public java.lang.String getStringArg​(java.lang.String name)

      • getStringArg

        public java.lang.String getStringArg​(java.lang.String name,
                                     java.lang.String def)

      • getIntArg

        public java.lang.Integer getIntArg​(java.lang.String name)

      • getIntArg

        public java.lang.Integer getIntArg​(java.lang.String name,
                                   java.lang.Integer def)

      • getLongArg

        public java.lang.Long getLongArg​(java.lang.String name)

      • getLongArg

        public java.lang.Long getLongArg​(java.lang.String name,
                                 java.lang.Long def)

      • getBooleanArg

        public java.lang.Boolean getBooleanArg​(java.lang.String name)

      • getBooleanArg

        public java.lang.Boolean getBooleanArg​(java.lang.String name,
                                       java.lang.Boolean def)

      • getDoubleArg

        public java.lang.Double getDoubleArg​(java.lang.String name)

      • getDoubleArg

        public java.lang.Double getDoubleArg​(java.lang.String name,
                                     java.lang.Double def)

      • getDateArg

        public java.util.Date getDateArg​(java.lang.String name)

      • getDateArg

        public java.util.Date getDateArg​(java.lang.String name,
                                 java.util.Date def)

      • getArg

        public java.lang.Object getArg​(java.lang.String name)

      • getArg

        public java.lang.Object getArg​(java.lang.String name,
                               java.lang.Object defaultValue)