A C D E G H I K L M N O P R S T

A

addPropertyListener(PropertyListener<T>) - Method in class org.syphr.prom.ManagedProperty
Add a new listener to be notified of events relevant to the property managed by this instance.
addPropertyListener(PropertyListener<T>) - Method in class org.syphr.prom.PropertiesManager
Add a listener for property events (such as change, save, load).
addReference(Reference) - Method in class org.syphr.prom.Reference
Add a sub reference to this instance.

C

changed(PropertyEvent<T>) - Method in interface org.syphr.prom.PropertyListener
Signal that one or more properties have been modified.
createRetriever() - Method in class org.syphr.prom.PropertiesManager
Build a new Retriever instance that will be used by the evaluator to request the values of nested property references.

D

Defaultable - Interface in org.syphr.prom
This interface defines functionality to provide a default property value.
DefaultEvaluator - Class in org.syphr.prom
This Evaluator implementation seeks to work the same way property evaluation works in Ant.
DefaultEvaluator() - Constructor for class org.syphr.prom.DefaultEvaluator
 

E

equals(Object) - Method in class org.syphr.prom.Reference
 
evaluate(String, Retriever) - Method in class org.syphr.prom.DefaultEvaluator
 
evaluate(String, Retriever) - Method in interface org.syphr.prom.Evaluator
Transform the given raw value into a fully evaluated value (including recursively nested references).
Evaluator - Interface in org.syphr.prom
This interface defines an object that can interrogate a raw value to determine if it references other values and provide information about those references.

G

getBooleanProperty() - Method in class org.syphr.prom.ManagedProperty
 
getBooleanProperty(T) - Method in class org.syphr.prom.PropertiesManager
Retrieve the value of the given property as a boolean.
getDefaultProperties(Class<T>, Translator<T>) - Static method in class org.syphr.prom.PropertiesManagers
Retrieve a Properties instance that contains all of the default values defined for the given Defaultable.
getDefaultTranslator(Class<T>) - Static method in class org.syphr.prom.PropertiesManagers
Get the default translator to convert back and forth between Enums and property names (keys).
getDefaultValue() - Method in interface org.syphr.prom.Defaultable
Retrieve the default value for key instance.
getDoubleProperty() - Method in class org.syphr.prom.ManagedProperty
 
getDoubleProperty(T) - Method in class org.syphr.prom.PropertiesManager
Retrieve the value of the given property as a double.
getEndPosition() - Method in class org.syphr.prom.Reference
Retrieve the end index (inclusive) of this reference in the original value in which it was nested.
getEnumProperty(Class<E>) - Method in class org.syphr.prom.ManagedProperty
 
getEnumProperty(T, Class<E>) - Method in class org.syphr.prom.PropertiesManager
Retrieve the value of the given property as an enum constant of the given type.

Note that this method requires the Enum constants to all have upper case names (following Java naming conventions).
getEvaluator() - Method in class org.syphr.prom.PropertiesManager
Retrieve the object that converts nested property references into evaluated strings.
getFile() - Method in class org.syphr.prom.PropertiesManager
 
getFloatProperty() - Method in class org.syphr.prom.ManagedProperty
 
getFloatProperty(T) - Method in class org.syphr.prom.PropertiesManager
Retrieve the value of the given property as a float.
getIntegerProperty() - Method in class org.syphr.prom.ManagedProperty
 
getIntegerProperty(T) - Method in class org.syphr.prom.PropertiesManager
Retrieve the value of the given property as an integer.
getLongProperty() - Method in class org.syphr.prom.ManagedProperty
 
getLongProperty(T) - Method in class org.syphr.prom.PropertiesManager
Retrieve the value of the given property as a long.
getManagedProperty(T) - Method in class org.syphr.prom.PropertiesManager
Get an object that will encapsulate the functionality of this manager specific to a single property.
getName() - Method in class org.syphr.prom.Reference
Retrieve the name of this reference.
getProperties() - Method in class org.syphr.prom.PropertiesManager
Retrieve a Properties instance that contains the properties managed by this instance.

Please note that the returned Properties instance is not connected in any way to this manager and is only a snapshot of what the properties looked like at the time the request was fulfilled.
getProperty() - Method in class org.syphr.prom.ManagedProperty
 
getProperty(T) - Method in class org.syphr.prom.PropertiesManager
Get the current value of the given property.

This method will block and wait for the properties to be loaded if they have not been already.
getProperty() - Method in class org.syphr.prom.PropertyEvent
Get the property associated with this event.
getPropertyKey() - Method in class org.syphr.prom.ManagedProperty
Retrieve the property key that is managed by this instance.
getPropertyKey(String) - Method in interface org.syphr.prom.Translator
This method translates the string property name into an Enum key that is used to reference the property via the properties management API.
getPropertyName(T) - Method in interface org.syphr.prom.Translator
This method translates the Enum key into a string property name that is used in the properties file.
getRawProperty() - Method in class org.syphr.prom.ManagedProperty
 
getRawProperty(T) - Method in class org.syphr.prom.PropertiesManager
Get the current value of the given property, but without translating references.
getReferences(String, Retriever) - Method in class org.syphr.prom.DefaultEvaluator
 
getReferences(String, Retriever) - Method in interface org.syphr.prom.Evaluator
Get a list of references contained within the given raw value.
getReferences() - Method in class org.syphr.prom.Reference
Retrieve a list of sub-references contained within the value of this reference.
getRetriever() - Method in class org.syphr.prom.PropertiesManager
Get the Retriever instance used internally to fetch values using an Evaluator.
getSource() - Method in class org.syphr.prom.PropertyEvent
 
getStartPosition() - Method in class org.syphr.prom.Reference
Retrieve the start index (inclusive) of this reference in the original value in which it was nested.
getTranslator() - Method in class org.syphr.prom.PropertiesManager
Retrieve the object that translates between Enum instances and property names (keys).
getValue() - Method in class org.syphr.prom.Reference
Retrieve the value of this reference, which may contain other references.

H

hashCode() - Method in class org.syphr.prom.Reference
 

I

isAutoTrim() - Method in class org.syphr.prom.PropertiesManager
Determine whether or not values will be automatically trimmed of whitespace as they are read.
isDefault() - Method in class org.syphr.prom.ManagedProperty
 
isDefault(T) - Method in class org.syphr.prom.PropertiesManager
Determine whether or not the given property is set to its default value.
isReferencing(String, String, Retriever) - Method in class org.syphr.prom.DefaultEvaluator
 
isReferencing(String, String, Retriever) - Method in interface org.syphr.prom.Evaluator
Determine whether or not the given raw value references another value by name.
isReferencing(T) - Method in class org.syphr.prom.ManagedProperty
 
isReferencing(T, T) - Method in class org.syphr.prom.PropertiesManager
Determine whether or not one property holds references to another property.
isSavingDefaults() - Method in class org.syphr.prom.PropertiesManager
Determine whether or not default values will be written to the properties file when and if it is saved.

K

keySet() - Method in class org.syphr.prom.PropertiesManager
Retrieve the set of keys currently in use by this manager.

L

loaded(PropertyEvent<T>) - Method in interface org.syphr.prom.PropertyListener
Signal that one or more properties have been loaded.

M

ManagedProperty<T extends Enum<T>> - Class in org.syphr.prom
This class provides the properties management API of PropertiesManager with respect to a single property.

To get access to an intance of this class, simple use PropertiesManager.getManagedProperty(Enum).

N

newManager(File, File, Class<T>) - Static method in class org.syphr.prom.PropertiesManagers
Build a new manager for the given properties file.
newManager(File, File, Class<T>, ExecutorService) - Static method in class org.syphr.prom.PropertiesManagers
Build a new manager for the given properties file.
newManager(File, Class<T>) - Static method in class org.syphr.prom.PropertiesManagers
Build a new manager for the given properties file.
newManager(File, Class<T>, ExecutorService) - Static method in class org.syphr.prom.PropertiesManagers
Build a new manager for the given properties file.
newManager(File, Class<T>, Translator<T>, ExecutorService) - Static method in class org.syphr.prom.PropertiesManagers
Build a new manager for the given properties file.
newManager(File, Class<T>, Evaluator, ExecutorService) - Static method in class org.syphr.prom.PropertiesManagers
Build a new manager for the given properties file.

O

org.syphr.prom - package org.syphr.prom
 

P

PropertiesManager<T extends Enum<T>> - Class in org.syphr.prom
This class creates a management API for a Properties file whose keys are described by an Enum.
PropertiesManager(File, Properties, Translator<T>, Evaluator, ExecutorService) - Constructor for class org.syphr.prom.PropertiesManager
Construct a new manager for the given properties file.
PropertiesManagers - Class in org.syphr.prom
This class provides builder methods to construct managers with various options.
PropertyEvent<T extends Enum<T>> - Class in org.syphr.prom
This event class encapsulates an event concerning a single property or a set of properties.
PropertyEvent(PropertiesManager<T>, T) - Constructor for class org.syphr.prom.PropertyEvent
Construct a new event.
PropertyException - Exception in org.syphr.prom
This exception is thrown to indicate and error in the properties management API (i.e.
PropertyException() - Constructor for exception org.syphr.prom.PropertyException
Constructs a new exception with null as its detail message.
PropertyException(String) - Constructor for exception org.syphr.prom.PropertyException
Constructs a new exception with the specified detail message.
PropertyException(String, Throwable) - Constructor for exception org.syphr.prom.PropertyException
Constructs a new exception with the specified detail message and cause.
PropertyException(Throwable) - Constructor for exception org.syphr.prom.PropertyException
Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).
PropertyListener<T extends Enum<T>> - Interface in org.syphr.prom
This listener defines the events that a client can react to when monitoring a single property or a set of properties.

R

Reference - Class in org.syphr.prom
This class encapsulates a reference to another property from within a property's value.
Reference(String, String, int, int) - Constructor for class org.syphr.prom.Reference
Construct a new reference.
referenceAt(String, int, Retriever) - Method in class org.syphr.prom.DefaultEvaluator
 
referenceAt(String, int, Retriever) - Method in interface org.syphr.prom.Evaluator
Retrieve the reference at the specified location, if one exists.
referenceAt(int) - Method in class org.syphr.prom.ManagedProperty
 
referenceAt(T, int) - Method in class org.syphr.prom.PropertiesManager
Determine whether or not a reference to another property exists in the value of the given property at the given position.
reload() - Method in class org.syphr.prom.PropertiesManager
Reload the current values of all properties.

This method will block and wait for the properties to be loaded.
reloadNB() - Method in class org.syphr.prom.PropertiesManager
Reload the current values of all properties.

This method will not block to wait for the properties to be loaded.
removePropertyListener(PropertyListener<T>) - Method in class org.syphr.prom.ManagedProperty
Remove an existing listener.
removePropertyListener(PropertyListener<T>) - Method in class org.syphr.prom.PropertiesManager
Remove a property listener.
reset() - Method in class org.syphr.prom.PropertiesManager
Reset the properties to the original defaults.
reset(PropertyEvent<T>) - Method in interface org.syphr.prom.PropertyListener
Signal that one or more properties have been reset.
resetProperty() - Method in class org.syphr.prom.ManagedProperty
Delegate to PropertiesManager.resetProperty(Enum).
resetProperty(T) - Method in class org.syphr.prom.PropertiesManager
Reset the given property to its default value.
retrieve(String) - Method in interface org.syphr.prom.Retriever
Retrieve the value associated with the given name.
Retriever - Interface in org.syphr.prom
This interface defines an interaction whereby the caller requests a value associated with the given name (such as the property-value relationship found in Properties).

S

save() - Method in class org.syphr.prom.PropertiesManager
Save the current values of all properties.

This method will block and wait for the properties to be saved.
saved(PropertyEvent<T>) - Method in interface org.syphr.prom.PropertyListener
Signal that one or more properties have been saved.
saveNB() - Method in class org.syphr.prom.PropertiesManager
Save the current values of all properties.

This method will not block to wait for the properties to be saved.
saveProperty(E) - Method in class org.syphr.prom.ManagedProperty
Delegate to PropertiesManager.saveProperty(Enum, Enum).
saveProperty(Object) - Method in class org.syphr.prom.ManagedProperty
Delegate to PropertiesManager.saveProperty(Enum, Object).
saveProperty(String) - Method in class org.syphr.prom.ManagedProperty
Delegate to PropertiesManager.saveProperty(Enum, String).
saveProperty(T, E) - Method in class org.syphr.prom.PropertiesManager
Save the given property using an Enum constant.
saveProperty(T, Object) - Method in class org.syphr.prom.PropertiesManager
Save the given property using an object's string representation.
saveProperty(T, String) - Method in class org.syphr.prom.PropertiesManager
Modify the value of the given property and save all properties to permanent storage.

This method will block and wait for the properties to be loaded if they have not been already.
setAutoTrim(boolean) - Method in class org.syphr.prom.PropertiesManager
Set the flag that determines whether or not values will be automatically trimmed of whitespace as they are read.
setComment(String) - Method in class org.syphr.prom.PropertiesManager
Set a comment that will be written to the file that stores the properties managed by this instance.

The default is no comment.
setProperty(E) - Method in class org.syphr.prom.ManagedProperty
Delegate to PropertiesManager.setProperty(Enum, Enum).
setProperty(Object) - Method in class org.syphr.prom.ManagedProperty
Delegate to PropertiesManager.setProperty(Enum, Object).
setProperty(String) - Method in class org.syphr.prom.ManagedProperty
Delegate to PropertiesManager.setProperty(Enum, String).
setProperty(T, E) - Method in class org.syphr.prom.PropertiesManager
Set the given property using an Enum constant.
setProperty(T, Object) - Method in class org.syphr.prom.PropertiesManager
Set the given property using an object's string representation.
setProperty(T, String) - Method in class org.syphr.prom.PropertiesManager
Set the given property using a string.
setSavingDefaults(boolean) - Method in class org.syphr.prom.PropertiesManager
Set the flag that determines whether or not default values are saved to the properties file when and if it is written.

T

Translator<T extends Enum<T>> - Interface in org.syphr.prom
This interface defines the functionality required to translate back and forth between key constants (Enums) and property names.

It is required that any implementation be thread safe.

A C D E G H I K L M N O P R S T

Copyright © 2010 syphr.org. All Rights Reserved.