Top Fields Constructors Methods
com.mysql.cj.conf

public abstract Class AbstractPropertyDefinition<T>

extends Object
implements PropertyDefinition<T>, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, com.mysql.cj.conf.PropertyDefinition
Known Direct Subclasses
com.mysql.cj.conf.BooleanPropertyDefinition, com.mysql.cj.conf.EnumPropertyDefinition, com.mysql.cj.conf.IntegerPropertyDefinition, com.mysql.cj.conf.LongPropertyDefinition, com.mysql.cj.conf.StringPropertyDefinition
Imports
java.io.Serializable, com.mysql.cj.exceptions.ExceptionInterceptor

Field Summary

Modifier and TypeField and Description
private String
category

private String
ccAlias

private T
defaultValue

private String
description

private boolean
isRuntimeModifiable

private PropertyKey
key

private int
lowerBound

private String
name

private int
order

private static final long
serialVersionUID

private String
sinceVersion

private int
upperBound

Constructor Summary

AccessConstructor and Description
public
AbstractPropertyDefinition(String name, String camelCaseAlias, T defaultValue, boolean isRuntimeModifiable, String description, String sinceVersion, String category, int orderInCategory)

public
AbstractPropertyDefinition(PropertyKey key, T defaultValue, boolean isRuntimeModifiable, String description, String sinceVersion, String category, int orderInCategory)

public
AbstractPropertyDefinition(PropertyKey key, T defaultValue, boolean isRuntimeModifiable, String description, String sinceVersion, String category, int orderInCategory, int lowerBound, int upperBound)

Method Summary

Modifier and TypeMethod and Description
public String[]
getAllowableValues()

Implements com.mysql.cj.conf.PropertyDefinition.getAllowableValues.

Returns the list of allowable values.

public String
getCategory()

Implements com.mysql.cj.conf.PropertyDefinition.getCategory.

Returns the property category.

public String
getCcAlias()

Implements com.mysql.cj.conf.PropertyDefinition.getCcAlias.

Returns the property camel-case alias.

public T
getDefaultValue()

Implements com.mysql.cj.conf.PropertyDefinition.getDefaultValue.

Returns the default value.

public String
getDescription()

Implements com.mysql.cj.conf.PropertyDefinition.getDescription.

Returns the property description.

public int
getLowerBound()

Implements com.mysql.cj.conf.PropertyDefinition.getLowerBound.

The lowest possible value of range-based property

public String
getName()

Implements com.mysql.cj.conf.PropertyDefinition.getName.

Returns the property name.

public int
getOrder()

Implements com.mysql.cj.conf.PropertyDefinition.getOrder.

Returns the property order.

public PropertyKey
getPropertyKey()

Implements com.mysql.cj.conf.PropertyDefinition.getPropertyKey.

Get the property key.

public String
getSinceVersion()

Implements com.mysql.cj.conf.PropertyDefinition.getSinceVersion.

Returns the driver version where the property was introduced first.

public int
getUpperBound()

Implements com.mysql.cj.conf.PropertyDefinition.getUpperBound.

The highest possible value of range-based property

public boolean
hasCcAlias()

Implements com.mysql.cj.conf.PropertyDefinition.hasCcAlias.

Returns true if property has a camel-case alias.

public boolean
hasValueConstraints()

Implements com.mysql.cj.conf.PropertyDefinition.hasValueConstraints.

Does the property have fixed values based constraints.

public boolean
isRangeBased()

Implements com.mysql.cj.conf.PropertyDefinition.isRangeBased.

Returns true if property has range-based constraints

public boolean
isRuntimeModifiable()

Implements com.mysql.cj.conf.PropertyDefinition.isRuntimeModifiable.

May the property be changed after initialization.

public abstract T
parseObject(String
value
value, ExceptionInterceptor
exception interceptor
exceptionInterceptor)

Redeclares com.mysql.cj.conf.PropertyDefinition.parseObject.

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

public void
setCategory(String category)

public void
setDefaultValue(T defaultValue)

public void
setDescription(String description)

public void
setLowerBound(int lowerBound)

public void
setOrder(int order)

public void
setRuntimeModifiable(boolean isRuntimeModifiable)

public void
setSinceVersion(String sinceVersion)

public void
setUpperBound(int upperBound)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

categoryback to summary
private String category
ccAliasback to summary
private String ccAlias
defaultValueback to summary
private T defaultValue
descriptionback to summary
private String description
isRuntimeModifiableback to summary
private boolean isRuntimeModifiable
keyback to summary
private PropertyKey key
lowerBoundback to summary
private int lowerBound
nameback to summary
private String name
orderback to summary
private int order
serialVersionUIDback to summary
private static final long serialVersionUID
sinceVersionback to summary
private String sinceVersion
upperBoundback to summary
private int upperBound

Constructor Detail

AbstractPropertyDefinitionback to summary
public AbstractPropertyDefinition(String name, String camelCaseAlias, T defaultValue, boolean isRuntimeModifiable, String description, String sinceVersion, String category, int orderInCategory)
AbstractPropertyDefinitionback to summary
public AbstractPropertyDefinition(PropertyKey key, T defaultValue, boolean isRuntimeModifiable, String description, String sinceVersion, String category, int orderInCategory)
AbstractPropertyDefinitionback to summary
public AbstractPropertyDefinition(PropertyKey key, T defaultValue, boolean isRuntimeModifiable, String description, String sinceVersion, String category, int orderInCategory, int lowerBound, int upperBound)

Method Detail

getAllowableValuesback to summary
public String[] getAllowableValues()

Implements com.mysql.cj.conf.PropertyDefinition.getAllowableValues.

Doc from com.mysql.cj.conf.PropertyDefinition.getAllowableValues.

Returns the list of allowable values.

Returns:String[]

the list of allowable values

Annotations
@Override
getCategoryback to summary
public String getCategory()

Implements com.mysql.cj.conf.PropertyDefinition.getCategory.

Doc from com.mysql.cj.conf.PropertyDefinition.getCategory.

Returns the property category.

Returns:String

property category

Annotations
@Override
getCcAliasback to summary
public String getCcAlias()

Implements com.mysql.cj.conf.PropertyDefinition.getCcAlias.

Doc from com.mysql.cj.conf.PropertyDefinition.getCcAlias.

Returns the property camel-case alias.

Returns:String

the property camel-case alias.

Annotations
@Override
getDefaultValueback to summary
public T getDefaultValue()

Implements com.mysql.cj.conf.PropertyDefinition.getDefaultValue.

Doc from com.mysql.cj.conf.PropertyDefinition.getDefaultValue.

Returns the default value.

Returns:T

default value

Annotations
@Override
getDescriptionback to summary
public String getDescription()

Implements com.mysql.cj.conf.PropertyDefinition.getDescription.

Doc from com.mysql.cj.conf.PropertyDefinition.getDescription.

Returns the property description. Used for documentation.

Returns:String

property description

Annotations
@Override
getLowerBoundback to summary
public int getLowerBound()

Implements com.mysql.cj.conf.PropertyDefinition.getLowerBound.

Doc from com.mysql.cj.conf.PropertyDefinition.getLowerBound.

The lowest possible value of range-based property

Returns:int

the lowest possible value of range-based property

Annotations
@Override
getNameback to summary
public String getName()

Implements com.mysql.cj.conf.PropertyDefinition.getName.

Doc from com.mysql.cj.conf.PropertyDefinition.getName.

Returns the property name.

Returns:String

the property name

Annotations
@Override
getOrderback to summary
public int getOrder()

Implements com.mysql.cj.conf.PropertyDefinition.getOrder.

Doc from com.mysql.cj.conf.PropertyDefinition.getOrder.

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

Returns:int

property order

Annotations
@Override
getPropertyKeyback to summary
public PropertyKey getPropertyKey()

Implements com.mysql.cj.conf.PropertyDefinition.getPropertyKey.

Doc from com.mysql.cj.conf.PropertyDefinition.getPropertyKey.

Get the property key.

Returns:PropertyKey

PropertyKey or null if it's a custom property.

Annotations
@Override
getSinceVersionback to summary
public String getSinceVersion()

Implements com.mysql.cj.conf.PropertyDefinition.getSinceVersion.

Doc from com.mysql.cj.conf.PropertyDefinition.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

Annotations
@Override
getUpperBoundback to summary
public int getUpperBound()

Implements com.mysql.cj.conf.PropertyDefinition.getUpperBound.

Doc from com.mysql.cj.conf.PropertyDefinition.getUpperBound.

The highest possible value of range-based property

Returns:int

the highest possible value of range-based property

Annotations
@Override
hasCcAliasback to summary
public boolean hasCcAlias()

Implements com.mysql.cj.conf.PropertyDefinition.hasCcAlias.

Doc from com.mysql.cj.conf.PropertyDefinition.hasCcAlias.

Returns true if property has a camel-case alias.

Returns:boolean

true if property has a camel-case alias.

Annotations
@Override
hasValueConstraintsback to summary
public boolean hasValueConstraints()

Implements com.mysql.cj.conf.PropertyDefinition.hasValueConstraints.

Doc from com.mysql.cj.conf.PropertyDefinition.hasValueConstraints.

Does the property have fixed values based constraints.

Returns:boolean

true if property has fixed values based constraints.

Annotations
@Override
isRangeBasedback to summary
public boolean isRangeBased()

Implements com.mysql.cj.conf.PropertyDefinition.isRangeBased.

Doc from com.mysql.cj.conf.PropertyDefinition.isRangeBased.

Returns true if property has range-based constraints

Returns:boolean

true if property has range-based constraints

Annotations
@Override
isRuntimeModifiableback to summary
public boolean isRuntimeModifiable()

Implements com.mysql.cj.conf.PropertyDefinition.isRuntimeModifiable.

Doc from com.mysql.cj.conf.PropertyDefinition.isRuntimeModifiable.

May the property be changed after initialization.

Returns:boolean

true if the property value may be changed after initialization.

Annotations
@Override
parseObjectback to summary
public abstract T parseObject(String value, ExceptionInterceptor exceptionInterceptor)

Redeclares com.mysql.cj.conf.PropertyDefinition.parseObject.

Doc from com.mysql.cj.conf.PropertyDefinition.parseObject.

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

Annotations
@Override
setCategoryback to summary
public void setCategory(String category)
setDefaultValueback to summary
public void setDefaultValue(T defaultValue)
setDescriptionback to summary
public void setDescription(String description)
setLowerBoundback to summary
public void setLowerBound(int lowerBound)
setOrderback to summary
public void setOrder(int order)
setRuntimeModifiableback to summary
public void setRuntimeModifiable(boolean isRuntimeModifiable)
setSinceVersionback to summary
public void setSinceVersion(String sinceVersion)
setUpperBoundback to summary
public void setUpperBound(int upperBound)