biolockj

Class Properties

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<Object,Object>

java.util.Properties

biolockj.Properties

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>

public class Properties
extends Properties

Load properties defined in the BioLockJ configuration file, including inherited properties from project.defaultProps

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

Constructor and Description
Properties() Default constructor.
Properties(Properties defaultConfig) Constructor called when "pipeline.defaultProps" contains a valid file-path

Method Summary

Modifier and Type	Method and Description
protected static Properties	buildConfig(File propFile) Recursive method handles nested default Config files.
protected static File	getDefaultConfig(File propFile) Parse property file for the property "pipeline.defaultProps".
protected void	load(FileInputStream fis) Load properties, adding escape characters where necessary.
static Properties	loadProperties(File file) Instantiate Properties via buildConfig(File)
protected static Properties	readProps(File propFile, Properties defaultProps) Read the properties defined in the required propFile and defaultProps (if included) to build Config. Properties in propFile will override the defaultProps.

Methods inherited from class java.util.Properties

getProperty, getProperty, list, list, load, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class java.util.Hashtable

clear, clone, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keys, keySet, merge, put, putAll, putIfAbsent, rehash, remove, remove, replace, replace, replaceAll, size, toString, values

Methods inherited from class java.lang.Object

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

Constructor Detail

Properties

public Properties()

Default constructor.

Properties

public Properties(Properties defaultConfig)

Constructor called when "pipeline.defaultProps" contains a valid file-path

Parameters:

defaultConfig - Config built from "pipeline.defaultProps" property

Method Detail

load

protected void load(FileInputStream fis)
             throws IOException

Load properties, adding escape characters where necessary.

Parameters:

fis - FileInputStream

Throws:

IOException - if unable to convert escape characters

loadProperties

public static Properties loadProperties(File file)
                                 throws Exception

Instantiate Properties via buildConfig(File)

Parameters:

file - of Properties file

Returns:

Properties Config properties loaded from files

Throws:

Exception - if unable to extract properties from filePath

buildConfig

protected static Properties buildConfig(File propFile)
                                 throws Exception

Recursive method handles nested default Config files. Default props are overridden by parent level props.
Standard properties are always imported 1st: "${BLJ}/resources/config/default/standard.properties"
Docker properties are always imported 2nd if in a Docker container: "${BLJ}/resources/config/default/docker.properties"
Then nested default Config files defined by property: "pipeline.defaultProps"
The project Config file is read last to ensure properties are not overridden in the default Config files.

Parameters:

propFile - BioLockJ Configuration file

Returns:

Properties including default props

Throws:

Exception - if errors occur

getDefaultConfig

protected static File getDefaultConfig(File propFile)
                                throws Exception

Parse property file for the property "pipeline.defaultProps".

Parameters:

propFile - BioLockJ Config file

Returns:

nested default prop file or null

Throws:

Exception - if errors occur

readProps

protected static Properties readProps(File propFile,
                                      Properties defaultProps)
                               throws FileNotFoundException,
                                      IOException

Read the properties defined in the required propFile and defaultProps (if included) to build Config.
Properties in propFile will override the defaultProps.

Parameters:

propFile - BioLockJ configuration file

defaultProps - Default properties

Returns:

Properties instance

Throws:

FileNotFoundException - thrown if propFile is not a valid file path

IOException - thrown if propFile or defaultProps cannot be parsed to read in properties