Package ca.cgjennings.apps.arkham.plugins.engine

Class SettingBindings

  • All Implemented Interfaces:
    java.util.Map<java.lang.String,​java.lang.Object>, javax.script.Bindings
    public class SettingBindings
extends java.lang.Object
implements javax.script.Bindings
    A script bindings implementation that allows access to Settings using variable names that start with $, UI strings using names that start with @, and game strings using names that start with #. It also defines the "magic" variables Editor and Component.
    Author:
    Chris Jennings

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      class  SettingBindings.LiveSetting
      A live setting is returned when the script uses $$-notation—two dollar signs instead of one—when reading a setting value in a script.

      • 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
      void clear()  
      boolean containsKey​(java.lang.Object key)  
      boolean containsValue​(java.lang.Object value)  
      java.util.Set<java.util.Map.Entry<java.lang.String,​java.lang.Object>> entrySet()  
      java.lang.Object get​(java.lang.Object key)  
      Language getGameLanguage()
      Returns the Language used to look up # variables.
      Settings getSettings()
      Returns the settings used to look up $ variables.
      Language getUILanguage()
      Returns the Language used to look up @ variables.
      boolean isEmpty()  
      java.util.Set<java.lang.String> keySet()  
      java.lang.Object put​(java.lang.String name, java.lang.Object value)  
      void putAll​(java.util.Map<? extends java.lang.String,​? extends java.lang.Object> toMerge)  
      java.lang.Object remove​(java.lang.Object key)  
      void setGameLanguage​(Language game)
      Returns the Language used to look up # variables.
      void setSettings​(Settings settings)
      Sets the settings used to look up $ and $$ variables.
      void setUILanguage​(Language ui)
      Returns the Language used to look up @ variables.
      static void setUndeclaredSettingWarningsEnabled​(boolean enable)
      Sets whether the bindings will report $-notation variables that have a null value are undefined.
      int size()  
      java.util.Collection<java.lang.Object> values()  

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface java.util.Map

        compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

    • Constructor Detail

      • SettingBindings

        public SettingBindings​(javax.script.Bindings parent)

      • SettingBindings

        public SettingBindings​(javax.script.Bindings parent,
                       Settings settings)

    • Method Detail

      • put

        public java.lang.Object put​(java.lang.String name,
                            java.lang.Object value)
        Specified by:
        put in interface javax.script.Bindings
        Specified by:
        put in interface java.util.Map<java.lang.String,​java.lang.Object>

      • get

        public java.lang.Object get​(java.lang.Object key)
        Specified by:
        get in interface javax.script.Bindings
        Specified by:
        get in interface java.util.Map<java.lang.String,​java.lang.Object>

      • putAll

        public void putAll​(java.util.Map<? extends java.lang.String,​? extends java.lang.Object> toMerge)
        Specified by:
        putAll in interface javax.script.Bindings
        Specified by:
        putAll in interface java.util.Map<java.lang.String,​java.lang.Object>

      • containsKey

        public boolean containsKey​(java.lang.Object key)
        Specified by:
        containsKey in interface javax.script.Bindings
        Specified by:
        containsKey in interface java.util.Map<java.lang.String,​java.lang.Object>

      • containsValue

        public boolean containsValue​(java.lang.Object value)
        Specified by:
        containsValue in interface java.util.Map<java.lang.String,​java.lang.Object>

      • remove

        public java.lang.Object remove​(java.lang.Object key)
        Specified by:
        remove in interface javax.script.Bindings
        Specified by:
        remove in interface java.util.Map<java.lang.String,​java.lang.Object>

      • size

        public int size()
        Specified by:
        size in interface java.util.Map<java.lang.String,​java.lang.Object>

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface java.util.Map<java.lang.String,​java.lang.Object>

      • clear

        public void clear()
        Specified by:
        clear in interface java.util.Map<java.lang.String,​java.lang.Object>

      • keySet

        public java.util.Set<java.lang.String> keySet()
        Specified by:
        keySet in interface java.util.Map<java.lang.String,​java.lang.Object>

      • values

        public java.util.Collection<java.lang.Object> values()
        Specified by:
        values in interface java.util.Map<java.lang.String,​java.lang.Object>

      • entrySet

        public java.util.Set<java.util.Map.Entry<java.lang.String,​java.lang.Object>> entrySet()
        Specified by:
        entrySet in interface java.util.Map<java.lang.String,​java.lang.Object>

      • getSettings

        public Settings getSettings()
        Returns the settings used to look up $ variables.
        Returns:
        the $ settings instance

      • setSettings

        public void setSettings​(Settings settings)
        Sets the settings used to look up $ and $$ variables.
        Parameters:
        settings - the $ settings instance

      • getUILanguage

        public Language getUILanguage()
        Returns the Language used to look up @ variables.
        Returns:
        the UI language instance

      • setUILanguage

        public void setUILanguage​(Language ui)
        Returns the Language used to look up @ variables.
        Parameters:
        ui - the UI language instance

      • getGameLanguage

        public Language getGameLanguage()
        Returns the Language used to look up # variables.
        Returns:
        the game language instance

      • setGameLanguage

        public void setGameLanguage​(Language game)
        Returns the Language used to look up # variables.
        Parameters:
        game - the game language instance

      • setUndeclaredSettingWarningsEnabled

        public static void setUndeclaredSettingWarningsEnabled​(boolean enable)
        Sets whether the bindings will report $-notation variables that have a null value are undefined.
        Parameters:
        enable - if true, null setting variables will not be "contained" by the map, resulting in additional warnings when script warnings are enabled
        See Also:
        containsKey(java.lang.Object)