com.varra.props

Class ApplicationProperties

java.lang.Object

com.varra.props.ApplicationProperties

All Implemented Interfaces:

Serializable

@InterfaceAudience.Public
 @InterfaceStability.Evolving
public class ApplicationProperties
extends Object
implements Serializable

This is the utility class to provide the application properties file details to be loaded for application.

Contains the properties file name and the flag to enable/disable the monitoring functionality.

Can add/remove the PropertyChangeListeners using VarraProperties.registerPropertyChangeListener(PropertyChangeListener, String...) and VarraProperties.unregisterPropertyChangeListener(PropertyChangeListener)

Version:

1.0

Author:

Rajakrishna V. Reddy

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ApplicationProperties(String propertyFileName) Instantiates a new application properties with the parameters given.
ApplicationProperties(String propertyFileName, boolean isMonitoringEnabled) Instantiates a new application properties with the parameters given.
ApplicationProperties(String propertyFileName, boolean isMonitoringEnabled, int interval) Instantiates a new application properties with the parameters given.

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(PropertyChangeListener listener) Adds the property change listener.
boolean	equals(Object obj)
Integer	getInterval() Gets the properties file monitor interval.
Properties	getProperties() Gets the properties.
File	getPropertyFile() Gets the property file.
String	getPropertyFileName() Gets the property file name.
int	hashCode()
boolean	isMonitoringEnabled() Checks if is monitoring enabled.
boolean	isValid(String propertyFileName) Checks if is valid application properties.
void	removePropertyChangeListener(PropertyChangeListener listener) Removes the property change listener.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ApplicationProperties

public ApplicationProperties(String propertyFileName)
                      throws PropertyFileLoaderException

Instantiates a new application properties with the parameters given.

Parameters:

propertyFileName - the property file name

Throws:

PropertyFileLoaderException - the property file loader exception

ApplicationProperties

public ApplicationProperties(String propertyFileName,
                             boolean isMonitoringEnabled)
                      throws PropertyFileLoaderException

Instantiates a new application properties with the parameters given.

Parameters:

propertyFileName - the property file name

isMonitoringEnabled - the is monitoring enabled

Throws:

PropertyFileLoaderException - the property file loader exception

ApplicationProperties

public ApplicationProperties(String propertyFileName,
                             boolean isMonitoringEnabled,
                             int interval)
                      throws PropertyFileLoaderException

Instantiates a new application properties with the parameters given.

Parameters:

propertyFileName - the property file name

isMonitoringEnabled - the is monitoring enabled

interval - the interval

Throws:

PropertyFileLoaderException - the property file loader exception

Method Detail

getPropertyFileName

public String getPropertyFileName()

Gets the property file name.

Returns:

the propertyFileName

isMonitoringEnabled

public boolean isMonitoringEnabled()

Checks if is monitoring enabled.

Returns:

the isMonitoringEnabled

getInterval

public Integer getInterval()

Gets the properties file monitor interval. This matters if the

Returns:

the interval isMonitoringEnabled() enabled (i.e. true).

isValid

@InterfaceAudience.LimitedPrivate(value="props")
 @InterfaceStability.Evolving
public boolean isValid(String propertyFileName)

Checks if is valid application properties.

Parameters:

propertyFileName - the property file name

Returns:

true, if is valid application properties

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getPropertyFile

public File getPropertyFile()

Gets the property file.

Returns:

the propertyFile

getProperties

public Properties getProperties()

Gets the properties.

Returns:

the properties

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Adds the property change listener.

Parameters:

listener - the listener

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Removes the property change listener.

Parameters:

listener - the listener

toString

public String toString()

Overrides:

toString in class Object