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

[legend]

Public Member Functions
final Double	getDbl (String key, Double defaultVal)
	get double value associated to key More...

Double	getDbl (String value)

final double []	getDblAry (String key, double[] defaultVal)
	get double array associated to key More...

double []	getDblAry (String value)
	get array of double from String More...

final Float	getFlt (String key, Float defaultVal)
	get float value associated to key More...

final Float	getFlt (String value)

final float []	getFltAry (String key, float[] defaultVal)
	get float array associated to key More...

float []	getFltAry (String value)

final Integer	getInt (String key, Integer defaultVal)
	get integer value associated to key More...

final int []	getIntAry (String key)
	get integer array associated to key More...

final Short	getShort (String key, Short defaultVal)
	get short value associated to key More...

Short	getShort (String value)

final String	getStr (String key)
	get value associated to keyword More...

final String	getStr (String key, String defaultVal)
	get value associated to key More...

	GrxConfigBundle ()
	constructor More...

	GrxConfigBundle (String fname) throws IOException
	construct from a file More...

final boolean	isFalse (String key)
	check whether value associated to key includes a word "false" More...

final boolean	isFalse (String key, boolean defaultVal)
	check whether value associated to key includes a word "false" More...

final boolean	isTrue (String key)
	check whether value associated to key includes a word "true" More...

final boolean	isTrue (String key, boolean defaultVal)
	check whether value associated to key includes a word "true" More...

void	load (String fname) throws IOException
	load config from a file More...

final void	setBool (String key, boolean value)

final void	setDbl (String key, double value)
	associate double value to key More...

final void	setDbl (String key, double value, int digits)
	associate double value to key More...

final void	setDblAry (String key, double[] value, int digits)
	associate double array to key More...

final void	setDblAry (String key, double[] value)
	associate double array to key More...

final void	setFlt (String key, float value)
	associate float value to key More...

final void	setFltAry (String key, float[] value)
	associate float array to key More...

final void	setInt (String key, int value)
	associate int value to key More...

final void	setShort (String key, short value)
	associate short value to key More...

void	store (String fname, String comments) throws IOException
	store this config More...

Detailed Description

Definition at line 34 of file GrxConfigBundle.java.

Constructor & Destructor Documentation

◆ GrxConfigBundle() [1/2]

com.generalrobotix.ui.util.GrxConfigBundle.GrxConfigBundle ( )

inline

constructor

Definition at line 38 of file GrxConfigBundle.java.

◆ GrxConfigBundle() [2/2]

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

◆ getDbl() [1/2]

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.

◆ getDbl() [2/2]

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.

◆ getDblAry() [1/2]

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.

◆ getDblAry() [2/2]

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.

◆ getFlt() [1/2]

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.

◆ getFlt() [2/2]

final Float com.generalrobotix.ui.util.GrxConfigBundle.getFlt ( String value )

inline

Definition at line 252 of file GrxConfigBundle.java.

◆ getFltAry() [1/2]

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.

◆ getFltAry() [2/2]

float [] com.generalrobotix.ui.util.GrxConfigBundle.getFltAry ( String value )

inline

Definition at line 318 of file GrxConfigBundle.java.

◆ getInt()

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.

◆ getIntAry()

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.

◆ getShort() [1/2]

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.

◆ getShort() [2/2]

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.

◆ getStr() [1/2]

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.

◆ getStr() [2/2]

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.

◆ isFalse() [1/2]

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.

◆ isFalse() [2/2]

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.

◆ isTrue() [1/2]

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.

◆ isTrue() [2/2]

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.

◆ load()

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.

◆ setBool()

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

inline

Definition at line 424 of file GrxConfigBundle.java.

◆ setDbl() [1/2]

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.

◆ setDbl() [2/2]

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.

◆ setDblAry() [1/2]

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.

◆ setDblAry() [2/2]

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.

◆ setFlt()

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.

◆ setFltAry()

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.

◆ setInt()

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.

◆ setShort()

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.

◆ store()

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ GrxConfigBundle() [1/2]

◆ GrxConfigBundle() [2/2]

Member Function Documentation

◆ getDbl() [1/2]

◆ getDbl() [2/2]

◆ getDblAry() [1/2]

◆ getDblAry() [2/2]

◆ getFlt() [1/2]

◆ getFlt() [2/2]

◆ getFltAry() [1/2]

◆ getFltAry() [2/2]

◆ getInt()

◆ getIntAry()

◆ getShort() [1/2]

◆ getShort() [2/2]

◆ getStr() [1/2]

◆ getStr() [2/2]

◆ isFalse() [1/2]

◆ isFalse() [2/2]

◆ isTrue() [1/2]

◆ isTrue() [2/2]

◆ load()

◆ setBool()

◆ setDbl() [1/2]

◆ setDbl() [2/2]

◆ setDblAry() [1/2]

◆ setDblAry() [2/2]

◆ setFlt()

◆ setFltAry()

◆ setInt()

◆ setShort()

◆ store()