Class ConfigMap

java.lang.Object
java.util.AbstractMap<String,String>
org.bgerp.app.cfg.ConfigMap
All Implemented Interfaces:
Map<String,String>
Direct Known Subclasses:
Preferences, SimpleConfigMap
public abstract class ConfigMap extends AbstractMap<String,String>
Key - value strings map.

  • Field Details

    • EMPTY

      public static ConfigMap EMPTY
      Empty config map

  • Constructor Details

    • ConfigMap

      protected ConfigMap()
      Default constructor

  • Method Details

    • get

      public abstract String get(String key, String def)
      Gets a value by key.
      Parameters:
      key - the key
      def - default value if the key is absent
      Returns:
      the value or def

    • entrySet

      public abstract Set<Map.Entry<String,String>> entrySet()
      Specified by:
      entrySet in interface Map<String,String>
      Specified by:
      entrySet in class AbstractMap<String,String>

    • get

      public String get(Object key)
      Specified by:
      get in interface Map<String,String>
      Overrides:
      get in class AbstractMap<String,String>

    • getSok

      public String getSok(String def, boolean validate, String... keys) throws BGMessageException
      Retrieves by key value with support of old keys.
      Parameters:
      def - default value.
      validate - throw an exception on using old keys.
      keys - first key is the actual one, after - olds.
      Returns:
      the value or def
      Throws:
      BGMessageException - if a deprecated key is used and validate is set

    • getSok

      public String getSok(String... keys)
      Retrieves by key value with support of old keys.
      Parameters:
      keys - first key is the actual one, after - olds.
      Returns:
      the value or null

    • getInt

      public int getInt(String key, int def)
      Gets an int value by key.
      Parameters:
      key - the key
      def - default value if absent or not parsable
      Returns:
      the value or def

    • getInt

      public int getInt(String key)
      Gets an int value by key, default 0.
      Parameters:
      key - the key
      Returns:
      the value or 0

    • getLong

      public long getLong(String key, long def)
      Gets a long value by key.
      Parameters:
      key - the key
      def - default value if absent or not parsable
      Returns:
      the value or def

    • getLong

      public long getLong(String key)
      Gets a long value by key, default 0.
      Parameters:
      key - the key
      Returns:
      the value or 0

    • getSokLong

      public long getSokLong(long def, boolean validate, String... keys) throws BGMessageException
      Retrieves by key value with support of old keys.
      Parameters:
      def - default value.
      validate - throw an exception on using old keys.
      keys - first key is the actual one, after - olds.
      Returns:
      the value or def
      Throws:
      BGMessageException - if a deprecated key is used and validate is set

    • getSokLong

      public long getSokLong(long def, String... keys)
      Retrieves by key value with support of old keys.
      Parameters:
      def - default value.
      keys - first key is the actual one, after - olds.
      Returns:
      the value or def

    • getBoolean

      public final boolean getBoolean(String key)
      Retrieves by key a boolean value with default false.
      Parameters:
      key - the key.
      Returns:
      the value or false
      See Also:

    • getBoolean

      public final boolean getBoolean(String key, boolean defaultValue)
      Retrieves by key a boolean value.
      Parameters:
      key - the key.
      defaultValue - default value.
      Returns:
      the value or defaultValue
      See Also:

    • getSokBoolean

      public boolean getSokBoolean(boolean def, boolean validate, String... keys) throws BGMessageException
      Retrieves by key value with support of old keys.
      Parameters:
      def - default value.
      validate - throw an exception on using old keys.
      keys - first key is the actual one, after - olds.
      Returns:
      the value or def
      Throws:
      BGMessageException - if a deprecated key is used and validate is set

    • getSokBoolean

      public boolean getSokBoolean(boolean def, String... keys)
      Retrieves by key value with support of old keys.
      Parameters:
      def - default value.
      keys - first key is the actual one, after - olds.
      Returns:
      the value or def

    • getBigDecimal

      public BigDecimal getBigDecimal(String key, BigDecimal def)
      Gets a BigDecimal value by key.
      Parameters:
      key - the key
      def - default value if absent or not parsable
      Returns:
      the value or def

    • sub

      public ConfigMap sub(String prefix)
      Creates a sub map by a key prefix 
      prefixkey1=value1
prefixkey2=value2
->
map
key1=value1
key2=value2
      Parameters:
      prefix - the key prefix for extraction
      Returns:
      not null config map

    • subSok

      public ConfigMap subSok(String... prefixes)
      Creates a sub map by key prefixes 
      prefixkey1=value1
prefixkey2=value2
->
config map
key1=value1
key2=value2
      Parameters:
      prefixes - key prefixes for extraction, the first one is the actual, the rest are deprecated prefixes
      Returns:
      not null config map

    • subIndexed

      public SortedMap<Integer, ConfigMap> subIndexed(String prefix)
      Creates a sorted map of maps by a key prefix 
      prefix1.12=2
prefix1.34=4
prefix2.56=2
prefix2.78=4
->
sorted Map
1={12=2,34=4}
2={56=2,78=4}
      Parameters:
      prefix - the key prefix for extraction
      Returns:
      not null map

    • subSokIndexed

      public SortedMap<Integer, ConfigMap> subSokIndexed(String... prefixes)
      Creates a sorted map of maps by key prefixes 
      prefix1.12=2
prefix1.34=4
prefix2.56=2
prefix2.78=4
->
sorted Map
1={12=2,34=4}
2={56=2,78=4}
      Parameters:
      prefixes - key prefixes for extraction, the first one is the actual, the rest are deprecated prefixes
      Returns:
      not null map

    • subKeyed

      public Map<String, ConfigMap> subKeyed(String prefix)
      Creates a map of maps by a key prefix 
      prefixa.12=2
prefixa.34=4
prefixb.56=u
prefixb.kk=4
->
unsorted map
a={12=2,34=4}
b={56=u,kk=4}
      Parameters:
      prefix - the key prefix for extraction
      Returns:
      not null map
      See Also:

    • getConfig

      public final <K extends Config> K getConfig(Class<K> clazz)
      Creates if needed and gets pre parsed and cached configuration. Cache key - the class object of the configuration.
      Type Parameters:
      K - configuration type
      Parameters:
      clazz - the configuration class.
      Returns:
      the configuration, or null if empty

    • getConfig

      public final Object getConfig(String className)
      Same with getConfig(Class), but with string parameter for calling from scripts. The method is less recommended as getConfig(Class), which is checked by compiler.
      Parameters:
      className - the full class name.
      Returns:
      the configuration, or null

    • removeConfig

      public <K extends Config> void removeConfig(Class<K> clazz)
      Removes config from cache.
      Type Parameters:
      K - configuration type
      Parameters:
      clazz - configuration class

    • clearConfigs

      protected void clearConfigs()
      Clears all the parsed configurations from configMap.

    • validateConfig

      public final <K extends Config> void validateConfig(Class<K> clazz) throws BGMessageException
      Creates a configuration for validation purposes only.
      Type Parameters:
      K - configuration type
      Parameters:
      clazz - configuration class
      Throws:
      BGMessageException - if the configuration is invalid

    • getDataString

      public String getDataString()
      Serializes the data to key=value string lines
      Returns:
      the string with pairs on lines