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

A

addPropertyListener(PropertyListener<T>) - Method in class org.syphr.prom.PropertiesManager
Add a listener for property events (such as change, save, load).
addPropertyListener(PropertyListener<T>) - Method in class org.syphr.prom.PropertyManager
Add a new listener to be notified of events relevant to the property managed by this instance.
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.
copy(File) - Method in class org.syphr.prom.PropertiesManager
Copy the current state of this manager to a new instance that is based on a different file.
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(T) - Method in class org.syphr.prom.PropertiesManager
Retrieve the value of the given property as a boolean.
getBooleanProperty() - Method in class org.syphr.prom.PropertyManager
 
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.
getDefaultValue() - Method in interface org.syphr.prom.Defaultable
Retrieve the default value for key instance.
getDoubleProperty(T) - Method in class org.syphr.prom.PropertiesManager
Retrieve the value of the given property as a double.
getDoubleProperty() - Method in class org.syphr.prom.PropertyManager
 
getDoublePropertyFallback(T) - Method in class org.syphr.prom.PropertiesManager
Retrieve the value of the given property as a double.
getDoublePropertyFallback() - Method in class org.syphr.prom.PropertyManager
 
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(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).
getEnumProperty(Class<E>) - Method in class org.syphr.prom.PropertyManager
 
getEnumPropertyFallback(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.
getEnumPropertyFallback(Class<E>) - Method in class org.syphr.prom.PropertyManager
 
getEnumTranslator(Class<T>) - Static method in class org.syphr.prom.PropertiesManagers
Get a simple translator to convert back and forth between Enums and property names (keys).
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(T) - Method in class org.syphr.prom.PropertiesManager
Retrieve the value of the given property as a float.
getFloatProperty() - Method in class org.syphr.prom.PropertyManager
 
getFloatPropertyFallback(T) - Method in class org.syphr.prom.PropertiesManager
Retrieve the value of the given property as a float.
getFloatPropertyFallback() - Method in class org.syphr.prom.PropertyManager
 
getIdentityTranslator() - Static method in class org.syphr.prom.PropertiesManagers
Create a translator that returns the string that it is given (no translation).
getIntegerProperty(T) - Method in class org.syphr.prom.PropertiesManager
Retrieve the value of the given property as an integer.
getIntegerProperty() - Method in class org.syphr.prom.PropertyManager
 
getIntegerPropertyFallback(T) - Method in class org.syphr.prom.PropertiesManager
Retrieve the value of the given property as an integer.
getIntegerPropertyFallback() - Method in class org.syphr.prom.PropertyManager
 
getLongProperty(T) - Method in class org.syphr.prom.PropertiesManager
Retrieve the value of the given property as a long.
getLongProperty() - Method in class org.syphr.prom.PropertyManager
 
getLongPropertyFallback(T) - Method in class org.syphr.prom.PropertiesManager
Retrieve the value of the given property as a long.
getLongPropertyFallback() - Method in class org.syphr.prom.PropertyManager
 
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 object that contains the properties managed by this instance.

Please note that the returned Properties object 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.
getProperties(File) - Static method in class org.syphr.prom.PropertiesManagers
Load values from a file.
getProperties(URL) - Static method in class org.syphr.prom.PropertiesManagers
Load values from a URL.
getProperty(T) - Method in class org.syphr.prom.PropertiesManager
Get the current value of the given property.
getProperty() - Method in class org.syphr.prom.PropertyEvent
Get the property associated with this event.
getProperty() - Method in class org.syphr.prom.PropertyManager
 
getPropertyKey() - Method in class org.syphr.prom.PropertyManager
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 key object that is used to reference the property via the properties management API.
getPropertyManager(T) - Method in class org.syphr.prom.PropertiesManager
Get an object that will encapsulate the functionality of this manager specific to a single property.
getPropertyName(T) - Method in interface org.syphr.prom.Translator
This method translates the key object into a string property name that is used in the properties file.
getRawProperty(T) - Method in class org.syphr.prom.PropertiesManager
Get the current value of the given property, but without translating references.
getRawProperty() - Method in class org.syphr.prom.PropertyManager
 
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 key objects and property names.
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(T) - Method in class org.syphr.prom.PropertiesManager
Determine whether or not the given property is set to its default value.
isDefault() - Method in class org.syphr.prom.PropertyManager
 
isModified(T) - Method in class org.syphr.prom.PropertiesManager
Determine whether or not the given property has been modified since it was last load or saved.
isModified() - Method in class org.syphr.prom.PropertiesManager
Determine whether or not any property has been modified since the last load or save.
isModified() - Method in class org.syphr.prom.PropertyManager
Delegate to isModified(Object).
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, T) - Method in class org.syphr.prom.PropertiesManager
Determine whether or not one property holds references to another property.
isReferencing(T) - Method in class org.syphr.prom.PropertyManager
 
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

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

This method will block and wait for the properties to be loaded.
loaded(PropertyEvent<T>) - Method in interface org.syphr.prom.PropertyListener
Signal that one or more properties have been loaded.
loadNB() - Method in class org.syphr.prom.PropertiesManager
Load the properties file.
loadProperty(T) - Method in class org.syphr.prom.PropertiesManager
Load the current value of the given property from the file without modifying the values of any other properties.
loadProperty() - Method in class org.syphr.prom.PropertyManager
Delegate to loadProperty(Object).
loadPropertyNB(T) - Method in class org.syphr.prom.PropertiesManager
Load the current value of the given property from the file without modifying the values of any other properties.
loadPropertyNB() - Method in class org.syphr.prom.PropertyManager
Delegate to loadPropertyNB(Object).

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, URL, 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, URL, 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> - Class in org.syphr.prom
This class creates a management API for a Properties file.
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> - 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.
PropertyListener<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.
PropertyManager<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 instance of this class, use getPropertyManager(Object).

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(T, int) - Method in class org.syphr.prom.PropertiesManager
Retrieve the reference to another property from within the value of the given property at the given position.
referenceAt(int) - Method in class org.syphr.prom.PropertyManager
 
removePropertyListener(PropertyListener<T>) - Method in class org.syphr.prom.PropertiesManager
Remove a property listener.
removePropertyListener(PropertyListener<T>) - Method in class org.syphr.prom.PropertyManager
Remove an existing 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(T) - Method in class org.syphr.prom.PropertiesManager
Reset the given property to its default value.
resetProperty() - Method in class org.syphr.prom.PropertyManager
Delegate to resetProperty(Object).
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(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 only that change to permanent storage.
saveProperty(T) - Method in class org.syphr.prom.PropertiesManager
Save the current value of the given property to the file without modifying the values of any other properties in the file.
saveProperty(E) - Method in class org.syphr.prom.PropertyManager
Delegate to saveProperty(Object, Enum).
saveProperty(Object) - Method in class org.syphr.prom.PropertyManager
Delegate to saveProperty(Object, Object).
saveProperty(String) - Method in class org.syphr.prom.PropertyManager
Delegate to saveProperty(Object, String).
saveProperty() - Method in class org.syphr.prom.PropertyManager
Delegate to saveProperty(Object).
savePropertyNB(T) - Method in class org.syphr.prom.PropertiesManager
Save the current value of the given property to the file without modifying the values of any other properties in the file.
savePropertyNB() - Method in class org.syphr.prom.PropertyManager
Delegate to savePropertyNB(Object).
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(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.
setProperty(E) - Method in class org.syphr.prom.PropertyManager
Delegate to setProperty(Object, Enum).
setProperty(Object) - Method in class org.syphr.prom.PropertyManager
Delegate to setProperty(Object, Object).
setProperty(String) - Method in class org.syphr.prom.PropertyManager
Delegate to setProperty(Object, 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> - 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 N O P R S T

Copyright © 2010-2012 Gregory P. Moyer. All Rights Reserved.