com.pervasive.datarush.graphs

Class EngineProperty<T>

java.lang.Object

com.pervasive.datarush.graphs.EngineProperty<T>

Type Parameters:

T - the type of the engine property

public class EngineProperty<T>
extends Object

Defined configuration properties for the DataRush engine.

Method Summary

Modifier and Type	Method and Description
static <T> EngineProperty<T>	defineProperty(String propertyName, String description, Class<T> propertyClass, T defaultValue) Creates a new engine property
static List<EngineProperty<?>>	discoverProperties(Class<?> clazz) Finds all public static final EngineProperty declarations of the given class and its inner classes.
static EngineProperty<?>	discoverProperty(Class<?> clazz, String name) Looks up engine properties by their property file keys.
boolean	equals(Object o)
T	getDefaultValue() Gets the default value for the property.
String	getDescription() Gets a description of the property.
String	getProperty() Gets the property key for use in properties files.
Class<T>	getPropertyClass() Returns the class of values of this property
int	hashCode()
T	parseValue(String value) Parses the given value from its text representation to the type of the property
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

defineProperty

public static <T> EngineProperty<T> defineProperty(String propertyName,
                                                   String description,
                                                   Class<T> propertyClass,
                                                   T defaultValue)

Creates a new engine property

Type Parameters:

T - the type of property

Parameters:

propertyName - the name of the property

description - the description of the property

propertyClass - the type of the property

defaultValue - the default value of the property

Returns:

a new engine property

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

parseValue

public T parseValue(String value)
             throws com.pervasive.datarush.graphs.physical.InvalidPropertyValueException

Parses the given value from its text representation to the type of the property

Parameters:

value - the next value

Returns:

the property value

Throws:

com.pervasive.datarush.graphs.physical.InvalidPropertyValueException - if a parse error occurs

getProperty

public final String getProperty()

Gets the property key for use in properties files.

Returns:

the property's key name

getDescription

public final String getDescription()

Gets a description of the property.

Returns:

the property's description

getDefaultValue

public T getDefaultValue()

Gets the default value for the property.

Returns:

the property's default

toString

public String toString()

Overrides:

toString in class Object

getPropertyClass

public final Class<T> getPropertyClass()

Returns the class of values of this property

Returns:

the class of values of this property

discoverProperties

public static List<EngineProperty<?>> discoverProperties(Class<?> clazz)

Finds all public static final EngineProperty declarations of the given class and its inner classes.

Parameters:

clazz - the class, usually EngineConfig

Returns:

all property declarations in the given class and inner classes

discoverProperty

public static EngineProperty<?> discoverProperty(Class<?> clazz,
                                                 String name)

Looks up engine properties by their property file keys.

Parameters:

clazz - the class containing property declarations

name - the key from the property file

Returns:

the associated engine property. null if no such property can be found.