com.mysql.cj.conf

Interface RuntimeProperty<T>

All Known Implementing Classes:

AbstractRuntimeProperty, BooleanProperty, EnumProperty, IntegerProperty, LongProperty, MemorySizeProperty, StringProperty

public interface RuntimeProperty<T>

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	RuntimeProperty.RuntimePropertyListener

Method Summary

Modifier and Type	Method and Description
void	addListener(RuntimeProperty.RuntimePropertyListener l) Add listener for this property changes.
T	getInitialValue() Get initial value (default or defined in connection string/Properties)
PropertyDefinition<T>	getPropertyDefinition()
java.lang.String	getStringValue() Get internal value representation as String.
T	getValue() Get internal value representation as Object.
void	initializeFrom(java.util.Properties extractFrom, ExceptionInterceptor exceptionInterceptor) Explicitly set value of this RuntimeProperty according to the self-titled property value contained in extractFrom.
void	initializeFrom(javax.naming.Reference ref, ExceptionInterceptor exceptionInterceptor)
boolean	isExplicitlySet()
void	removeListener(RuntimeProperty.RuntimePropertyListener l)
void	resetValue() Reset to initial value (default or defined in connection string/Properties)
void	setValue(T value) Set the object value of a property directly.
void	setValue(T value, ExceptionInterceptor exceptionInterceptor) Set the object value of a property directly.

Method Detail

getPropertyDefinition

PropertyDefinition<T> getPropertyDefinition()

initializeFrom

void initializeFrom(java.util.Properties extractFrom,
                    ExceptionInterceptor exceptionInterceptor)

Explicitly set value of this RuntimeProperty according to the self-titled property value contained in extractFrom. This method is called during PropertySet initialization thus ignores the RUNTIME_NOT_MODIFIABLE flag.

This value will also be the initial one, i.e. resetValue() will reset to this value, not the default one.

If extractFrom does not contain such property then this RuntimeProperty remains unchanged.

Parameters:

extractFrom - Properties object containing key-value pairs usually passed from connection string.

exceptionInterceptor - exceptionInterceptor

initializeFrom

void initializeFrom(javax.naming.Reference ref,
                    ExceptionInterceptor exceptionInterceptor)

resetValue

void resetValue()

Reset to initial value (default or defined in connection string/Properties)

isExplicitlySet

boolean isExplicitlySet()

addListener

void addListener(RuntimeProperty.RuntimePropertyListener l)

Add listener for this property changes.

Parameters:

l - RuntimeProperty.RuntimePropertyListener

removeListener

void removeListener(RuntimeProperty.RuntimePropertyListener l)

getValue

T getValue()

Get internal value representation as Object.

Returns:

value

getInitialValue

T getInitialValue()

Get initial value (default or defined in connection string/Properties)

Returns:

value

getStringValue

java.lang.String getStringValue()

Get internal value representation as String.

Returns:

value

setValue

void setValue(T value)

Set the object value of a property directly. Validation against allowable values will be performed.

Parameters:

value - value

setValue

void setValue(T value,
              ExceptionInterceptor exceptionInterceptor)

Set the object value of a property directly. Validation against allowable values will be performed.

Parameters:

value - value

exceptionInterceptor - exception interceptor