Class Settings


  • public class Settings
    extends java.lang.Object
    This class defines a singleton where SkyView preferences/settings Testchange... can be set and gotten from anywhere in the system. A setting is simply a key=string value. When there is to be more than one value for the key it should be specified as string1,string2,string3. A comma is not allowed as a character within a setting. Keys are case insensitive.

    When specified in the command line Settings may sometimes be set with just the keyword. This is treated as equivalent to key=1.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static void add​(java.lang.String key, java.lang.String value)
      Add a setting to a list -- but only if it is not already in the list.
      static void addArgs​(java.lang.String[] args)
      Add settings from a list of arguments.
      static void addToken​(java.lang.String arg)
      Add a single argument token
      static java.lang.String get​(java.lang.String key)
      Get a value corresponding to the key
      static java.lang.String get​(java.lang.String key, java.lang.String dft)
      Get a values corresponding to a key or the default
      static java.lang.String[] getArray​(java.lang.String key)
      Get the values corresponding to a key as an array of strings.
      static java.lang.String[] getKeys()
      Return the array of keys in the current settings
      static boolean has​(java.lang.String key)
      Check if the given key has been set
      static java.util.HashMap<java.lang.String,​java.lang.String> pop()
      Give a copy of the current settings and pop the stack
      static void push​(java.util.HashMap<java.lang.String,​java.lang.String> top)  
      static void put​(java.lang.String key, java.lang.String value)
      Save a key and value
      static void restore()
      Restore a previously saved state.
      static void save()
      Save the current state of the settings for a later restoration
      static void suggest​(java.lang.String key, java.lang.String value)
      This method works like put except that it does not add a pair if the keys is in the _nullvalues setting or if the Setting is already set (unless it is set to the special value "default")
      static void updateFromFile​(java.lang.String settingsFile)
      Try to read settings from a file
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • updateFromFile

        public static void updateFromFile​(java.lang.String settingsFile)
        Try to read settings from a file
      • addArgs

        public static void addArgs​(java.lang.String[] args)
        Add settings from a list of arguments. This is probably the argument list given to main, but needn't be.
      • addToken

        public static void addToken​(java.lang.String arg)
        Add a single argument token
      • get

        public static java.lang.String get​(java.lang.String key)
        Get a value corresponding to the key
      • get

        public static java.lang.String get​(java.lang.String key,
                                           java.lang.String dft)
        Get a values corresponding to a key or the default
      • getArray

        public static java.lang.String[] getArray​(java.lang.String key)
        Get the values corresponding to a key as an array of strings. Returns null rather than a 0 length array if the value is not set.
      • suggest

        public static void suggest​(java.lang.String key,
                                   java.lang.String value)
        This method works like put except that it does not add a pair if the keys is in the _nullvalues setting or if the Setting is already set (unless it is set to the special value "default")
      • put

        public static void put​(java.lang.String key,
                               java.lang.String value)
        Save a key and value
      • save

        public static void save()
        Save the current state of the settings for a later restoration
      • add

        public static void add​(java.lang.String key,
                               java.lang.String value)
        Add a setting to a list -- but only if it is not already in the list.
      • has

        public static boolean has​(java.lang.String key)
        Check if the given key has been set
      • getKeys

        public static java.lang.String[] getKeys()
        Return the array of keys in the current settings
      • restore

        public static void restore()
        Restore a previously saved state.
      • pop

        public static java.util.HashMap<java.lang.String,​java.lang.String> pop()
        Give a copy of the current settings and pop the stack
      • push

        public static void push​(java.util.HashMap<java.lang.String,​java.lang.String> top)