Top Methods
com.mysql.cj.conf

public Interface PropertyDefinition<T>

Known Direct Implementers
com.mysql.cj.conf.AbstractPropertyDefinition
Imports
com.mysql.cj.exceptions.ExceptionInterceptor

Method Summary

Modifier and TypeMethod and Description
public RuntimeProperty<T>

Returns:

RuntimeProperty instance
createRuntimeProperty()

Creates instance of ReadableProperty or ModifiableProperty depending on isRuntimeModifiable() result.

public String[]

Returns:

the list of allowable values
getAllowableValues()

Returns the list of allowable values.

public String

Returns:

property category
getCategory()

Returns the property category.

public String

Returns:

the property camel-case alias.
getCcAlias()

Returns the property camel-case alias.

public T

Returns:

default value
getDefaultValue()

Returns the default value.

public String

Returns:

property description
getDescription()

Returns the property description.

public int

Returns:

the lowest possible value of range-based property
getLowerBound()

The lowest possible value of range-based property

public String

Returns:

the property name
getName()

Returns the property name.

public int

Returns:

property order
getOrder()

Returns the property order.

public PropertyKey

Returns:

PropertyKey or null if it's a custom property.
getPropertyKey()

Get the property key.

public String

Returns:

the driver version where the property was introduced first
getSinceVersion()

Returns the driver version where the property was introduced first.

public int

Returns:

the highest possible value of range-based property
getUpperBound()

The highest possible value of range-based property

public boolean

Returns:

true if property has a camel-case alias.
hasCcAlias()

Returns true if property has a camel-case alias.

public boolean

Returns:

true if property has fixed values based constraints.
hasValueConstraints()

Does the property have fixed values based constraints.

public boolean

Returns:

true if property has range-based constraints
isRangeBased()

Returns true if property has range-based constraints

public boolean

Returns:

true if the property value may be changed after initialization.
isRuntimeModifiable()

May the property be changed after initialization.

public T

Returns:

the value object
parseObject(String
value
value, ExceptionInterceptor
exception interceptor
exceptionInterceptor)

Returns the value object parsed from it's string representation and checked against allowable values.

Method Detail

createRuntimePropertyback to summary
public RuntimeProperty<T> createRuntimeProperty()

Creates instance of ReadableProperty or ModifiableProperty depending on isRuntimeModifiable() result.

Returns:RuntimeProperty<T>

RuntimeProperty instance

getAllowableValuesback to summary
public String[] getAllowableValues()

Returns the list of allowable values.

Returns:String[]

the list of allowable values

getCategoryback to summary
public String getCategory()

Returns the property category.

Returns:String

property category

getCcAliasback to summary
public String getCcAlias()

Returns the property camel-case alias.

Returns:String

the property camel-case alias.

getDefaultValueback to summary
public T getDefaultValue()

Returns the default value.

Returns:T

default value

getDescriptionback to summary
public String getDescription()

Returns the property description. Used for documentation.

Returns:String

property description

getLowerBoundback to summary
public int getLowerBound()

The lowest possible value of range-based property

Returns:int

the lowest possible value of range-based property

getNameback to summary
public String getName()

Returns the property name.

Returns:String

the property name

getOrderback to summary
public int getOrder()

Returns the property order. Used as preferred property position in properties table in documentation.

Returns:int

property order

getPropertyKeyback to summary
public PropertyKey getPropertyKey()

Get the property key.

Returns:PropertyKey

PropertyKey or null if it's a custom property.

getSinceVersionback to summary
public String getSinceVersion()

Returns the driver version where the property was introduced first. Used for documentation.

Returns:String

the driver version where the property was introduced first

getUpperBoundback to summary
public int getUpperBound()

The highest possible value of range-based property

Returns:int

the highest possible value of range-based property

hasCcAliasback to summary
public boolean hasCcAlias()

Returns true if property has a camel-case alias.

Returns:boolean

true if property has a camel-case alias.

hasValueConstraintsback to summary
public boolean hasValueConstraints()

Does the property have fixed values based constraints.

Returns:boolean

true if property has fixed values based constraints.

isRangeBasedback to summary
public boolean isRangeBased()

Returns true if property has range-based constraints

Returns:boolean

true if property has range-based constraints

isRuntimeModifiableback to summary
public boolean isRuntimeModifiable()

May the property be changed after initialization.

Returns:boolean

true if the property value may be changed after initialization.

parseObjectback to summary
public T parseObject(String value, ExceptionInterceptor exceptionInterceptor)

Returns the value object parsed from it's string representation and checked against allowable values.

Parameters
value:String

value

exceptionInterceptor:ExceptionInterceptor

exception interceptor

Returns:T

the value object