com.generalrobotix.ui.util.GrxConfigBundle Class Reference

Inheritance diagram for com.generalrobotix.ui.util.GrxConfigBundle:

List of all members.

Public Member Functions
final Double	getDbl (String key, Double defaultVal)
	get double value associated to key
Double	getDbl (String value)
final double[]	getDblAry (String key, double[] defaultVal)
	get double array associated to key
double[]	getDblAry (String value)
	get array of double from String
final Float	getFlt (String key, Float defaultVal)
	get float value associated to key
final Float	getFlt (String value)
final float[]	getFltAry (String key, float[] defaultVal)
	get float array associated to key
float[]	getFltAry (String value)
final Integer	getInt (String key, Integer defaultVal)
	get integer value associated to key
final int[]	getIntAry (String key)
	get integer array associated to key
final Short	getShort (String key, Short defaultVal)
	get short value associated to key
Short	getShort (String value)
final String	getStr (String key)
	get value associated to keyword
final String	getStr (String key, String defaultVal)
	get value associated to key
	GrxConfigBundle ()
	constructor
	GrxConfigBundle (String fname) throws IOException
	construct from a file
final boolean	isFalse (String key)
	check whether value associated to key includes a word "false"
final boolean	isFalse (String key, boolean defaultVal)
	check whether value associated to key includes a word "false"
final boolean	isTrue (String key)
	check whether value associated to key includes a word "true"
final boolean	isTrue (String key, boolean defaultVal)
	check whether value associated to key includes a word "true"
void	load (String fname) throws IOException
	load config from a file
final void	setBool (String key, boolean value)
final void	setDbl (String key, double value)
	associate double value to key
final void	setDbl (String key, double value, int digits)
	associate double value to key
final void	setDblAry (String key, double[] value, int digits)
	associate double array to key
final void	setDblAry (String key, double[] value)
	associate double array to key
final void	setFlt (String key, float value)
	associate float value to key
final void	setFltAry (String key, float[] value)
	associate float array to key
final void	setInt (String key, int value)
	associate int value to key
final void	setShort (String key, short value)
	associate short value to key
void	store (String fname, String comments) throws IOException
	store this config

---

Detailed Description

Definition at line 34 of file GrxConfigBundle.java.

---

Constructor & Destructor Documentation

com.generalrobotix.ui.util.GrxConfigBundle.GrxConfigBundle

(

)

[inline]

constructor

Definition at line 38 of file GrxConfigBundle.java.

com.generalrobotix.ui.util.GrxConfigBundle.GrxConfigBundle

(

String

fname

)

throws IOException [inline]

construct from a file

Parameters:

fname

file name

Exceptions:

IOException

Definition at line 47 of file GrxConfigBundle.java.

---

Member Function Documentation

final Double com.generalrobotix.ui.util.GrxConfigBundle.getDbl	(	String	key,
		Double	defaultVal
	)		[inline]

get double value associated to key

Parameters:

key	keyword
defaultVal	default value

Returns:

double value associated to key if obtained, defaultVal otherwise

Definition at line 212 of file GrxConfigBundle.java.

Double com.generalrobotix.ui.util.GrxConfigBundle.getDbl

(

String

value

)

[inline]

get Double from String

Parameters:

value

string

Returns:

Double value if converted successfully, null otherwise

Definition at line 226 of file GrxConfigBundle.java.

final double [] com.generalrobotix.ui.util.GrxConfigBundle.getDblAry	(	String	key,
		double[]	defaultVal
	)		[inline]

get double array associated to key

Parameters:

key	keyword
defaultVal	default value

Returns:

double array associated to key

Definition at line 268 of file GrxConfigBundle.java.

double [] com.generalrobotix.ui.util.GrxConfigBundle.getDblAry

(

String

value

)

[inline]

get array of double from String

Parameters:

value

string of space separated double values

Returns:

array of double if converted successfully, null otherwise

Definition at line 283 of file GrxConfigBundle.java.

final Float com.generalrobotix.ui.util.GrxConfigBundle.getFlt	(	String	key,
		Float	defaultVal
	)		[inline]

get float value associated to key

Parameters:

key	keyword
defaultVal	default value

Returns:

float value associated to key

Definition at line 242 of file GrxConfigBundle.java.

final Float com.generalrobotix.ui.util.GrxConfigBundle.getFlt

(

String

value

)

[inline]

Definition at line 252 of file GrxConfigBundle.java.

final float [] com.generalrobotix.ui.util.GrxConfigBundle.getFltAry	(	String	key,
		float[]	defaultVal
	)		[inline]

get float array associated to key

Parameters:

key	keyword
defaultVal	default value

Returns:

float array associated to key

Definition at line 302 of file GrxConfigBundle.java.

float [] com.generalrobotix.ui.util.GrxConfigBundle.getFltAry

(

String

value

)

[inline]

Definition at line 318 of file GrxConfigBundle.java.

final Integer com.generalrobotix.ui.util.GrxConfigBundle.getInt	(	String	key,
		Integer	defaultVal
	)		[inline]

get integer value associated to key

Parameters:

key	keyword
defaultVal	default value

Returns:

integer value associated to key

Definition at line 134 of file GrxConfigBundle.java.

final int [] com.generalrobotix.ui.util.GrxConfigBundle.getIntAry

(

String

key

)

[inline]

get integer array associated to key

Parameters:

key

keyword

Returns:

integer array associated to key

Definition at line 190 of file GrxConfigBundle.java.

final Short com.generalrobotix.ui.util.GrxConfigBundle.getShort	(	String	key,
		Short	defaultVal
	)		[inline]

get short value associated to key

Parameters:

key	keyword
defaultVal	default value

Returns:

short value associated to key if obtained, defaultVal otherwise

Definition at line 150 of file GrxConfigBundle.java.

Short com.generalrobotix.ui.util.GrxConfigBundle.getShort

(

String

value

)

[inline]

get Short from String

Parameters:

value

String

Returns:

Short value if converted successfully, null otherwise

Definition at line 164 of file GrxConfigBundle.java.

final String com.generalrobotix.ui.util.GrxConfigBundle.getStr

(

String

key

)

[inline]

get value associated to keyword

Parameters:

key

keyword

Returns:

value associated to keyword. If value can not be found in this config and environment variables, null is returned

Definition at line 78 of file GrxConfigBundle.java.

final String com.generalrobotix.ui.util.GrxConfigBundle.getStr	(	String	key,
		String	defaultVal
	)		[inline]

get value associated to key

Parameters:

key	keyword
defaultVal	default return value

Returns:

value associated to key. If it can't be found, default value is returned.

Definition at line 121 of file GrxConfigBundle.java.

final boolean com.generalrobotix.ui.util.GrxConfigBundle.isFalse

(

String

key

)

[inline]

check whether value associated to key includes a word "false"

Parameters:

key

keyword

Returns:

true if value associated to key includes a word "false", false otherwise

Definition at line 459 of file GrxConfigBundle.java.

final boolean com.generalrobotix.ui.util.GrxConfigBundle.isFalse	(	String	key,
		boolean	defaultVal
	)		[inline]

check whether value associated to key includes a word "false"

Parameters:

key

keyword

Returns:

true if value associated to key includes a word "false", false otherwise

Definition at line 468 of file GrxConfigBundle.java.

final boolean com.generalrobotix.ui.util.GrxConfigBundle.isTrue

(

String

key

)

[inline]

check whether value associated to key includes a word "true"

Parameters:

key

keyword

Returns:

true if value associated to key includes a word "true", false otherwise

Definition at line 436 of file GrxConfigBundle.java.

final boolean com.generalrobotix.ui.util.GrxConfigBundle.isTrue	(	String	key,
		boolean	defaultVal
	)		[inline]

check whether value associated to key includes a word "true"

Parameters:

key	keyword
defaultVal	default value

Returns:

true if value associated to key includes a word "true", false otherwise

Definition at line 446 of file GrxConfigBundle.java.

void com.generalrobotix.ui.util.GrxConfigBundle.load

(

String

fname

)

throws IOException [inline]

load config from a file

Parameters:

fname

filename

Exceptions:

IOException

Definition at line 56 of file GrxConfigBundle.java.

final void com.generalrobotix.ui.util.GrxConfigBundle.setBool	(	String	key,
		boolean	value
	)		[inline]

Definition at line 424 of file GrxConfigBundle.java.

final void com.generalrobotix.ui.util.GrxConfigBundle.setDbl	(	String	key,
		double	value
	)		[inline]

associate double value to key

Parameters:

key	keyword
value	double value

Definition at line 393 of file GrxConfigBundle.java.

final void com.generalrobotix.ui.util.GrxConfigBundle.setDbl	(	String	key,
		double	value,
		int	digits
	)		[inline]

associate double value to key

Parameters:

key	keyword
value	double value
digits	digits to format

Definition at line 405 of file GrxConfigBundle.java.

final void com.generalrobotix.ui.util.GrxConfigBundle.setDblAry	(	String	key,
		double[]	value,
		int	digits
	)		[inline]

associate double array to key

Parameters:

key	keyword
value	double array
digits	for format

Definition at line 337 of file GrxConfigBundle.java.

final void com.generalrobotix.ui.util.GrxConfigBundle.setDblAry	(	String	key,
		double[]	value
	)		[inline]

associate double array to key

Parameters:

key	keyword
value	double array

Definition at line 356 of file GrxConfigBundle.java.

final void com.generalrobotix.ui.util.GrxConfigBundle.setFlt	(	String	key,
		float	value
	)		[inline]

associate float value to key

Parameters:

key	keyword
value	double value

Definition at line 369 of file GrxConfigBundle.java.

final void com.generalrobotix.ui.util.GrxConfigBundle.setFltAry	(	String	key,
		float[]	value
	)		[inline]

associate float array to key

Parameters:

key	keyword
value	float array

Definition at line 380 of file GrxConfigBundle.java.

final void com.generalrobotix.ui.util.GrxConfigBundle.setInt	(	String	key,
		int	value
	)		[inline]

associate int value to key

Parameters:

key	keyword
value	int value

Definition at line 418 of file GrxConfigBundle.java.

final void com.generalrobotix.ui.util.GrxConfigBundle.setShort	(	String	key,
		short	value
	)		[inline]

associate short value to key

Parameters:

key	keyword
value	short value

Definition at line 179 of file GrxConfigBundle.java.

void com.generalrobotix.ui.util.GrxConfigBundle.store	(	String	fname,
		String	comments
	)		throws IOException [inline]

store this config

Parameters:

fname	file name
comments	comments

Exceptions:

IOException

Definition at line 68 of file GrxConfigBundle.java.

---

The documentation for this class was generated from the following file:

• GrxConfigBundle.java