org.openecomp.policy.common.logging.flexlogger

Class PropertyUtil

java.lang.Object

org.openecomp.policy.common.logging.flexlogger.PropertyUtil

public class PropertyUtil
extends Object

This class provides utilities to read properties from a properties file, and optionally get notifications of future changes

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PropertyUtil.Listener This is the callback interface, used for sending notifications of changes in the properties file.
static class	PropertyUtil.Test

Constructor Summary

Constructors

Constructor and Description
PropertyUtil()

Method Summary

Modifier and Type	Method and Description
static Properties	getProperties(File file) Read in a properties file
static Properties	getProperties(File file, PropertyUtil.Listener listener) Read in a properties file, and register for update notifications.
static Properties	getProperties(String fileName) Read in a properties file
static Properties	getProperties(String fileName, PropertyUtil.Listener listener) Read in a properties file, and register for update notifications.
static void	stopListening(File file, PropertyUtil.Listener listener) Stop listenening for updates
static void	stopListening(String fileName, PropertyUtil.Listener listener) Stop listenening for updates

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyUtil

public PropertyUtil()

Method Detail

getProperties

public static Properties getProperties(File file)
                                throws IOException

Read in a properties file

Parameters:

file - the properties file

Returns:

a Properties object, containing the associated properties

Throws:

IOException - - subclass 'FileNotFoundException' if the file does not exist or can't be opened, and 'IOException' if there is a problem loading the properties file.

getProperties

public static Properties getProperties(String fileName)
                                throws IOException

Read in a properties file

Parameters:

fileName - the properties file

Returns:

a Properties object, containing the associated properties

Throws:

IOException - - subclass 'FileNotFoundException' if the file does not exist or can't be opened, and 'IOException' if there is a problem loading the properties file.

getProperties

public static Properties getProperties(File file,
                                       PropertyUtil.Listener listener)
                                throws IOException

Read in a properties file, and register for update notifications. NOTE: it is possible that the first callback will occur while this method is still in progress. To avoid this problem, use 'synchronized' blocks around this invocation and in the callback -- that will ensure that the processing of the initial properties complete before any updates are processed.

Parameters:

file - the properties file

notify - if not null, this is a callback interface that is used for notifications of changes

Returns:

a Properties object, containing the associated properties

Throws:

IOException - - subclass 'FileNotFoundException' if the file does not exist or can't be opened, and 'IOException' if there is a problem loading the properties file.

getProperties

public static Properties getProperties(String fileName,
                                       PropertyUtil.Listener listener)
                                throws IOException

Read in a properties file, and register for update notifications. NOTE: it is possible that the first callback will occur while this method is still in progress. To avoid this problem, use 'synchronized' blocks around this invocation and in the callback -- that will ensure that the processing of the initial properties complete before any updates are processed.

Parameters:

fileName - the properties file

notify - if not null, this is a callback interface that is used for notifications of changes

Returns:

a Properties object, containing the associated properties

Throws:

IOException - - subclass 'FileNotFoundException' if the file does not exist or can't be opened, and 'IOException' if there is a problem loading the properties file.

stopListening

public static void stopListening(File file,
                                 PropertyUtil.Listener listener)

Stop listenening for updates

Parameters:

file - the properties file

notify - if not null, this is a callback interface that was used for notifications of changes

stopListening

public static void stopListening(String fileName,
                                 PropertyUtil.Listener listener)

Stop listenening for updates

Parameters:

fileName - the properties file

notify - if not null, this is a callback interface that was used for notifications of changes