org.wandora.utils

Class Options

java.lang.Object

org.wandora.utils.Options

Direct Known Subclasses:

HttpAuthorizer

public class Options
extends java.lang.Object

Options is a LinkedHashMap wrapper class. Options is used to store all important settings in Wandora between use sessions. Options support XML import and export. Import and export features use methods in XMLbox utility class. Options converts XML paths to simple dot notation strings.

Author:

akivela

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.LinkedHashMap<java.lang.String,java.lang.String>	options
private java.lang.String	resource

Constructor Summary

Constructors

Constructor and Description
Options()
Options(Options opts)
Options(java.lang.String optionsResource) Creates a new instance of Options

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	asMap() Used to pick up all available options.
java.lang.String	findKeyFor(java.lang.String value) Method iterates all values in options and returns first key i.e.
private java.lang.String	fixIndexes(java.lang.String key)
private java.lang.String	fixIndexes(java.lang.String key, boolean fixAlsoLast) Private method used to add indexes into an options key.
java.lang.String	get(java.lang.String key) Returns value for the given key.
java.lang.String	get(java.lang.String key, java.lang.String defaultValue) Returns value for the given key or defaultValue if key resolves no value.
boolean	getBoolean(java.lang.String key, boolean defaultValue)
double	getDouble(java.lang.String key)
double	getDouble(java.lang.String key, double defaultValue)
float	getFloat(java.lang.String key)
float	getFloat(java.lang.String key, float defaultValue)
int	getInt(java.lang.String key) Shortcut method that returns options value as integer or 0 (zero) if value can not be parsed to an integer.
int	getInt(java.lang.String key, int defaultValue) Shortcut method that returns options value as integer or defaultValue if value can not be converted to an integer.
boolean	isFalse(java.lang.String key) Shortcut method to discover boolean value of given options key.
boolean	isTrue(java.lang.String key) Shortcut to discover boolean value of given options key.
java.util.Collection<java.lang.String>	keySet()
void	parseOptions(java.io.BufferedReader reader)
void	parseOptions(java.lang.String content) Parses given XML string and sets options to parsed content.
void	parseOptions(java.lang.String content, java.lang.String encoding) Parses given XML string and sets options to parsed content.
void	print()
void	put(java.lang.String key, double value) Shortcut method to store double numbers to options.
void	put(java.lang.String key, float value) Shortcut method to store float numbers to options.
void	put(java.lang.String key, int value) Shortcut method to store integer numbers to options.
void	put(java.lang.String key, java.lang.String value) This is the actual put method every other put method uses.
void	putAll(java.util.Map<java.lang.String,java.lang.String> map, java.lang.String prefix) Adds all key-value pairs from a map into this one.
void	removeAll(java.lang.String path) Removes all key-value pairs that start with given key path string.
void	save()
void	save(java.io.Writer out)

Methods inherited from class java.lang.Object

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

Field Detail

options

private java.util.LinkedHashMap<java.lang.String,java.lang.String> options

resource

private java.lang.String resource

Constructor Detail

Options

public Options(java.lang.String optionsResource)

Creates a new instance of Options

Options

public Options()

Options

public Options(Options opts)

Method Detail

asMap

public java.util.Map<java.lang.String,java.lang.String> asMap()

Used to pick up all available options.

Returns:

Map with all options.

fixIndexes

private java.lang.String fixIndexes(java.lang.String key,
                                    boolean fixAlsoLast)

Private method used to add indexes into an options key.

Parameters:

key -

fixAlsoLast - Should method add explicit index to the last path part also

Returns:

Fixed key containing indexes.

fixIndexes

private java.lang.String fixIndexes(java.lang.String key)

get

public java.lang.String get(java.lang.String key,
                            java.lang.String defaultValue)

Returns value for the given key or defaultValue if key resolves no value.

Parameters:

key - Object (

defaultValue -

Returns:

get

public java.lang.String get(java.lang.String key)

Returns value for the given key. If key has no prefix "options." it is added to the key. Also, key is modified by fixIndexes method.

Parameters:

key - String path for the returned value

Returns:

String value stored in options with key or null if key resolves no value.

getInt

public int getInt(java.lang.String key)

Shortcut method that returns options value as integer or 0 (zero) if value can not be parsed to an integer.

Parameters:

key - String representing key path of the returned integer value.

Returns:

Integer number stored to options with key or 0.

getInt

public int getInt(java.lang.String key,
                  int defaultValue)

Shortcut method that returns options value as integer or defaultValue if value can not be converted to an integer.

Parameters:

key - String representing key path of the returned integer value.

defaultValue - Integer number returned if key resolved value can not be converted to an integer.

Returns:

Integer number stored to options with key or defaultValue.

getDouble

public double getDouble(java.lang.String key)

getDouble

public double getDouble(java.lang.String key,
                        double defaultValue)

getFloat

public float getFloat(java.lang.String key)

getFloat

public float getFloat(java.lang.String key,
                      float defaultValue)

getBoolean

public boolean getBoolean(java.lang.String key,
                          boolean defaultValue)

put

public void put(java.lang.String key,
                int value)

Shortcut method to store integer numbers to options.

Parameters:

key -

value - Integer number that will be stored to options with key.

put

public void put(java.lang.String key,
                double value)

Shortcut method to store double numbers to options.

Parameters:

key -

value - Double number to be stored to options.

put

public void put(java.lang.String key,
                float value)

Shortcut method to store float numbers to options.

Parameters:

key -

value - Float number to be stored to options.

put

public void put(java.lang.String key,
                java.lang.String value)

This is the actual put method every other put method uses. If key has no "options." prefix, it is added to the key. If value is null then method removes given key in options.

Parameters:

key - String key

value - String value of the key

findKeyFor

public java.lang.String findKeyFor(java.lang.String value)

Method iterates all values in options and returns first key i.e. path that contains the key. If options contains no value string, method returns null.

Parameters:

value - String representing options value.

Returns:

String representing options path or null

isTrue

public boolean isTrue(java.lang.String key)

Shortcut to discover boolean value of given options key.

Parameters:

key - String representing options path

Returns:

true if value is "true" or "a". Returns false otherwise.

isFalse

public boolean isFalse(java.lang.String key)

Shortcut method to discover boolean value of given options key.

Parameters:

key - String representing options path

Returns:

true if value is not null, neither "false" or "0". Returns false otherwise.

removeAll

public void removeAll(java.lang.String path)

Removes all key-value pairs that start with given key path string. Method is used to clean up options.

Parameters:

path - String representing options path.

putAll

public void putAll(java.util.Map<java.lang.String,java.lang.String> map,
                   java.lang.String prefix)

Adds all key-value pairs from a map into this one.

Parameters:

map - The values to add.

prefix - A prefix to add all key-value pairs.

parseOptions

public void parseOptions(java.lang.String content)

Parses given XML string and sets options to parsed content. This method passes the parsing to parseOptions(String content, String encoding)

Parameters:

content - String containing valid XML document.

parseOptions

public void parseOptions(java.lang.String content,
                         java.lang.String encoding)

Parses given XML string and sets options to parsed content.

Parameters:

content - String containing valid XML document.

encoding - String representing content encoding.

parseOptions

public void parseOptions(java.io.BufferedReader reader)
                  throws java.io.IOException

Throws:

java.io.IOException

print

public void print()

save

public void save(java.io.Writer out)
          throws java.io.IOException

Throws:

java.io.IOException

save

public void save()

keySet

public java.util.Collection<java.lang.String> keySet()