com.cisco.thunderhead.connector

Class PropertiesConfiguration

java.lang.Object

com.cisco.thunderhead.connector.PropertiesConfiguration

public class PropertiesConfiguration
extends Object

Properties file loader with the ability to automatically persist property changes.

Constructor Summary

Constructors

Constructor and Description
PropertiesConfiguration()
PropertiesConfiguration(java.nio.file.Path path) Initialize a set of configuration properties from the contents of a properties file.
PropertiesConfiguration(String path)

Method Summary

Modifier and Type	Method and Description
int	getInt(String name, int def) Retrieve the value of an integer property.
String	getString(String name) Retrieve the value of a string property.
void	load(java.nio.file.Path path) Load property values from the specified properties file.
void	save(java.nio.file.Path path) Persist all property values to the specified file.
void	setAutoSave(boolean save) Specify whether or not changes to property values should be automatically persisted to the properties file.
void	setProperty(String name, int value) Set the value of an integer property.
void	setProperty(String name, String value) Set the value of a string property.
PropertiesConfiguration	subset(String prefix) Extract all property values whose name contains the specifed prefix (dot-separated property names).

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertiesConfiguration

public PropertiesConfiguration()

PropertiesConfiguration

public PropertiesConfiguration(java.nio.file.Path path)
                        throws IOException,
                               URISyntaxException

Initialize a set of configuration properties from the contents of a properties file. By default, changes to the properties set are not automatically re-saved to the file.

Parameters:

path - pathname of the file from which to load the initial property values

Throws:

IOException

URISyntaxException

PropertiesConfiguration

public PropertiesConfiguration(String path)
                        throws IOException,
                               URISyntaxException

Throws:

IOException

URISyntaxException

Method Detail

getString

public String getString(String name)

Retrieve the value of a string property.

Parameters:

name - name of the property value to retrieve

Returns:

value of the property or null if no value exists

getInt

public int getInt(String name,
                  int def)

Retrieve the value of an integer property.

Parameters:

name - name of the property value to retrieve

def - default value to use if no value exists

Returns:

value of the property

setProperty

public void setProperty(String name,
                        String value)
                 throws IOException

Set the value of a string property. If auto-save is configured, the new value will be persisted to the properties file.

Parameters:

name - name of the property value to set

value - new value

Throws:

IOException

setProperty

public void setProperty(String name,
                        int value)
                 throws IOException

Set the value of an integer property. If auto-save is configured, the new value will be persisted to the properties file.

Parameters:

name - name of the property value to set

value - new value

Throws:

IOException

setAutoSave

public void setAutoSave(boolean save)

Specify whether or not changes to property values should be automatically persisted to the properties file.

Parameters:

save - true if changes to property values should be automatically persisted.

load

public void load(java.nio.file.Path path)
          throws IOException

Load property values from the specified properties file.

Parameters:

path - pathname to file from which to load property values

Throws:

IOException

save

public void save(java.nio.file.Path path)
          throws IOException

Persist all property values to the specified file.

Parameters:

path - pathname to the file in which to persist the property values

Throws:

IOException

subset

public PropertiesConfiguration subset(String prefix)
                               throws IOException

Extract all property values whose name contains the specifed prefix (dot-separated property names). The prefix will be stripped from all properties in the resulting set.

Parameters:

prefix - property name prefix

Returns:

Throws:

IOException