Package de.srsoftware.localconfig

Class Configuration

java.lang.Object

java.util.AbstractMap<K,V>

java.util.TreeMap<String,String>

de.srsoftware.localconfig.Configuration

All Implemented Interfaces:

Serializable, Cloneable, Map<String,String>, NavigableMap<String,String>, SortedMap<String,String>

public class Configuration
extends TreeMap<String,String>

This class provides means to save program configuration

Author:

Stephan Richter

See Also:

Serialized Form

Nested Class Summary

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

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

Constructor Summary

Constructors

Constructor	Description
Configuration(File f)	Load configuration from file
Configuration(Path filename)	Load configuration from file

Method Summary

Modifier and Type	Method	Description
void	copy(Configuration source, String field)
static Path	dir(String programName)	returns the directory path, where config files should be stored.
File	file()
static Configuration	forApplication(String appName)
Boolean	getBool(String key)	will evaluate 1 or "true" (ignoring case) as true, every other value as false
Double	getDouble(String key)
Integer	getInt(String key)
boolean	getOrAdd(String key, boolean defaultValue)
double	getOrAdd(String key, double defaultValue)
int	getOrAdd(String key, int defaultValue)
String	getOrAdd(String key, String defaultValue)
static AbstractMap.SimpleEntry<String,String>	keyValue(String line)
String	put(String key, boolean value)
String	put(String key, Number value)
String	put(String key, String value)
void	save()
void	saveAs(File file)
String	toString()
static String	uncomment(String line)

Methods inherited from class java.util.TreeMap

ceilingEntry, ceilingKey, clear, clone, comparator, containsKey, containsValue, descendingKeySet, descendingMap, entrySet, firstEntry, firstKey, floorEntry, floorKey, forEach, get, headMap, headMap, higherEntry, higherKey, keySet, lastEntry, lastKey, lowerEntry, lowerKey, navigableKeySet, pollFirstEntry, pollLastEntry, putAll, remove, replace, replace, replaceAll, size, subMap, subMap, tailMap, tailMap, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, isEmpty

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove

Constructor Detail

Configuration

public Configuration(Path filename)

Load configuration from file

Parameters:

filename - the path to the configuration file

Configuration

public Configuration(File f)

Load configuration from file

Parameters:

f - the configuration file

Method Detail

copy

public void copy(Configuration source,
                 String field)

dir

public static Path dir(String programName)

returns the directory path, where config files should be stored.

Parameters:

programName - the name of the program, for which the configuration is managed.

Returns:

file

public File file()

forApplication

public static Configuration forApplication(String appName)
                                    throws FileNotFoundException

Throws:

FileNotFoundException

getOrAdd

public String getOrAdd(String key,
                       String defaultValue)
                throws IOException

Throws:

IOException

getOrAdd

public boolean getOrAdd(String key,
                        boolean defaultValue)
                 throws IOException

Throws:

IOException

getOrAdd

public double getOrAdd(String key,
                       double defaultValue)
                throws IOException

Throws:

IOException

getOrAdd

public int getOrAdd(String key,
                    int defaultValue)
             throws IOException

Throws:

IOException

getBool

public Boolean getBool(String key)

will evaluate 1 or "true" (ignoring case) as true, every other value as false

Parameters:

key -

Returns:

getDouble

public Double getDouble(String key)

getInt

public Integer getInt(String key)

keyValue

public static AbstractMap.SimpleEntry<String,String> keyValue(String line)
                                                             throws UnexpectedException

Throws:

UnexpectedException

put

public String put(String key,
                  String value)

Specified by:

put in interface Map<String,String>

Overrides:

put in class TreeMap<String,String>

put

public String put(String key,
                  Number value)

put

public String put(String key,
                  boolean value)

save

public void save()
          throws IOException

Throws:

IOException

saveAs

public void saveAs(File file)
            throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class AbstractMap<String,String>

uncomment

public static String uncomment(String line)