Modifier and Type	Class and Description
public static class	HsqlProperties.PropertyMeta

Modifier and Type	Field and Description
public static final int	ANY_ERROR
protected int[]	errorCodes
protected String[]	errorKeys
protected FileAccess	fa
protected String	fileExtension
protected String	fileName
public static final int	NO_VALUE_FOR_KEY
protected Properties	stringProps

Access	Constructor and Description
public	HsqlProperties()
public	HsqlProperties(String fileName)
public	HsqlProperties(String fileName, String fileExtension)
public	HsqlProperties(String fileName, FileAccess accessor, boolean b)
public	HsqlProperties(Properties props)

Method Summary

Modifier and Type	Method and Description
protected void	addError(int code, String key) Adds the error code and the key to the list of errors.
public void	addProperties(Properties props)
public void	addProperties(HsqlProperties props)
public static HsqlProperties	argArrayToProps(String[] arg, String type) Creates and populates an HsqlProperties Object from the arguments array of a Main method.
public static HsqlProperties	delimitedArgPairsToProps(String s, String pairsep, String dlimiter, String type) Creates and populates a new HsqlProperties Object using a string such as "key1=value1;key2=value2".
public String[]	getErrorKeys()
public int	getIntegerProperty(String key, int defaultValue)
public static int	getIntegerProperty(Properties props, String key, int defaultValue)
public Properties	getProperties()
public String	getProperty(String key)
public String	getProperty(String key, String defaultValue)
public boolean	isEmpty()
public boolean	isPropertyTrue(String key)
public boolean	isPropertyTrue(String key, boolean defaultValue)
public boolean	load()
public static HsqlProperties.PropertyMeta	newMeta(String name, int type, long defaultVal)
public static HsqlProperties.PropertyMeta	newMeta(String name, int type, String defaultValue)
public static HsqlProperties.PropertyMeta	newMeta(String name, int type, String defaultValue, String[] options)
public static HsqlProperties.PropertyMeta	newMeta(String name, int type, boolean defaultValue)
public static HsqlProperties.PropertyMeta	newMeta(String name, int type, int defaultValue, int[] values)
public static HsqlProperties.PropertyMeta	newMeta(String name, int type, int defaultValue, int rangeLow, int rangeHigh)
public boolean	propertiesFileExists()
public Enumeration<E>	propertyNames()
public void	removeProperty(String key)
public void	save() Saves the properties.
public void	save(String fileString) Saves the properties
public void	setFileName(String name)
public String	setProperty(String key, int value)
public String	setProperty(String key, boolean value)
public String	setProperty(String key, String value)
public String	setPropertyIfNotExists(String key, String value)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	validate()
public static String	validateProperty(String key, String value, HsqlProperties.PropertyMeta meta) Performs any range checking for property and return an error message

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

ANY_ERROR	back to summary
public static final int ANY_ERROR

errorCodes	back to summary
protected int[] errorCodes

errorKeys	back to summary
protected String[] errorKeys

fa	back to summary
protected FileAccess fa

fileExtension	back to summary
protected String fileExtension

fileName	back to summary
protected String fileName

NO_VALUE_FOR_KEY	back to summary
public static final int NO_VALUE_FOR_KEY

stringProps	back to summary
protected Properties stringProps

Constructor Detail

HsqlProperties	back to summary
public HsqlProperties()

HsqlProperties	back to summary
public HsqlProperties(String fileName)

HsqlProperties	back to summary
public HsqlProperties(String fileName, String fileExtension)

HsqlProperties	back to summary
public HsqlProperties(String fileName, FileAccess accessor, boolean b)

HsqlProperties	back to summary
public HsqlProperties(Properties props)

Method Detail

addError	back to summary
protected void addError(int code, String key) Adds the error code and the key to the list of errors. This list is populated during construction or addition of elements and is used outside this class to act upon the errors.

addProperties	back to summary
public void addProperties(Properties props)

addProperties	back to summary
public void addProperties(HsqlProperties props)

argArrayToProps	back to summary
public static HsqlProperties argArrayToProps(String[] arg, String type) Creates and populates an HsqlProperties Object from the arguments array of a Main method. Properties are in the form of "-key value" pairs. Each key is prefixed with the type argument and a dot before being inserted into the properties Object. "--help" is treated as a key with no value and not inserted.

argArrayToProps

back to summary

public static HsqlProperties argArrayToProps(String[] arg, String type)

Creates and populates an HsqlProperties Object from the arguments array of a Main method. Properties are in the form of "-key value" pairs. Each key is prefixed with the type argument and a dot before being inserted into the properties Object.

"--help" is treated as a key with no value and not inserted.

delimitedArgPairsToProps	back to summary
public static HsqlProperties delimitedArgPairsToProps(String s, String pairsep, String dlimiter, String type) Creates and populates a new HsqlProperties Object using a string such as "key1=value1;key2=value2". The string that represents the = sign above is specified as pairsep and the one that represents the semicolon is specified as delimiter, allowing any string to be used for either. Leading / trailing spaces around the keys and values are discarded. The string is parsed by (1) subdividing into segments by delimiter (2) subdividing each segment in two by finding the first instance of the pairsep (3) trimming each pair of segments from step 2 and inserting into the properties object. Each key is prefixed with the type argument and a dot before being inserted. Any key without a value is added to the list of errors.

delimitedArgPairsToProps

back to summary

public static HsqlProperties delimitedArgPairsToProps(String s, String pairsep, String dlimiter, String type)

Creates and populates a new HsqlProperties Object using a string such as "key1=value1;key2=value2".

The string that represents the = sign above is specified as pairsep and the one that represents the semicolon is specified as delimiter, allowing any string to be used for either.

Leading / trailing spaces around the keys and values are discarded.

The string is parsed by (1) subdividing into segments by delimiter (2) subdividing each segment in two by finding the first instance of the pairsep (3) trimming each pair of segments from step 2 and inserting into the properties object.

Each key is prefixed with the type argument and a dot before being inserted.

Any key without a value is added to the list of errors.

getErrorKeys	back to summary
public String[] getErrorKeys()

getIntegerProperty	back to summary
public int getIntegerProperty(String key, int defaultValue)

getIntegerProperty	back to summary
public static int getIntegerProperty(Properties props, String key, int defaultValue)

getProperties	back to summary
public Properties getProperties()

getProperty	back to summary
public String getProperty(String key)

getProperty	back to summary
public String getProperty(String key, String defaultValue)

isEmpty	back to summary
public boolean isEmpty()

isPropertyTrue	back to summary
public boolean isPropertyTrue(String key)

isPropertyTrue	back to summary
public boolean isPropertyTrue(String key, boolean defaultValue)

load	back to summary
public boolean load() throws Exception

newMeta	back to summary
public static HsqlProperties.PropertyMeta newMeta(String name, int type, long defaultVal)

newMeta	back to summary
public static HsqlProperties.PropertyMeta newMeta(String name, int type, String defaultValue)

newMeta	back to summary
public static HsqlProperties.PropertyMeta newMeta(String name, int type, String defaultValue, String[] options)

newMeta	back to summary
public static HsqlProperties.PropertyMeta newMeta(String name, int type, boolean defaultValue)

newMeta	back to summary
public static HsqlProperties.PropertyMeta newMeta(String name, int type, int defaultValue, int[] values)

newMeta	back to summary
public static HsqlProperties.PropertyMeta newMeta(String name, int type, int defaultValue, int rangeLow, int rangeHigh)

propertiesFileExists	back to summary
public boolean propertiesFileExists()

propertyNames	back to summary
public Enumeration<E> propertyNames()

removeProperty	back to summary
public void removeProperty(String key)

save	back to summary
public void save() throws Exception Saves the properties.

save	back to summary
public void save(String fileString) throws Exception Saves the properties

setFileName	back to summary
public void setFileName(String name)

setProperty	back to summary
public String setProperty(String key, int value)

setProperty	back to summary
public String setProperty(String key, boolean value)

setProperty	back to summary
public String setProperty(String key, String value)

setPropertyIfNotExists	back to summary
public String setPropertyIfNotExists(String key, String value)

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned.

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

validate	back to summary
public void validate()

validateProperty	back to summary
public static String validateProperty(String key, String value, HsqlProperties.PropertyMeta meta) Performs any range checking for property and return an error message

org.hsqldb.persist back to summary

public Class HsqlProperties.PropertyMeta

Class Inheritance

extends Object

java.lang.Object
org.hsqldb.persist.HsqlProperties.PropertyMeta

Field Summary

Modifier and Type	Field and Description
public String	propClass
public Object	propDefaultValue
public boolean	propIsRange
public String	propName
public String[]	propOptions
public int	propRangeHigh
public int	propRangeLow
public int	propType
public int[]	propValues

Constructor Summary

Access	Constructor and Description
public	PropertyMeta()

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

propClass	back to summary
public String propClass

propDefaultValue	back to summary
public Object propDefaultValue

propIsRange	back to summary
public boolean propIsRange

propName	back to summary
public String propName

propOptions	back to summary
public String[] propOptions

propRangeHigh	back to summary
public int propRangeHigh

propRangeLow	back to summary
public int propRangeLow

propType	back to summary
public int propType

propValues	back to summary
public int[] propValues

Constructor Detail

PropertyMeta	back to summary
public PropertyMeta()

public Class HsqlProperties

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class HsqlProperties.PropertyMeta

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail