org.apache.shardingsphere.infra.hint

Enum SQLHintPropertiesKey

java.lang.Object

java.lang.Enum<SQLHintPropertiesKey>

org.apache.shardingsphere.infra.hint.SQLHintPropertiesKey

All Implemented Interfaces:

Serializable, Comparable<SQLHintPropertiesKey>, TypedPropertyKey

public enum SQLHintPropertiesKey
extends Enum<SQLHintPropertiesKey>
implements TypedPropertyKey

Typed property key of SQL Hint.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DATASOURCE_NAME_KEY Hint data source name.
USE_TRAFFIC Whether to use traffic or not.
WRITE_ROUTE_ONLY_KEY Whether hint route write data source or not.

Method Summary

Modifier and Type	Method and Description
static SQLHintPropertiesKey	valueOf(String name) Returns the enum constant of this type with the specified name.
static SQLHintPropertiesKey[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.shardingsphere.infra.properties.TypedPropertyKey

getDefaultValue, getKey, getType

Enum Constant Detail

DATASOURCE_NAME_KEY

public static final SQLHintPropertiesKey DATASOURCE_NAME_KEY

Hint data source name.

WRITE_ROUTE_ONLY_KEY

public static final SQLHintPropertiesKey WRITE_ROUTE_ONLY_KEY

Whether hint route write data source or not.

USE_TRAFFIC

public static final SQLHintPropertiesKey USE_TRAFFIC

Whether to use traffic or not.

Method Detail

values

public static SQLHintPropertiesKey[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SQLHintPropertiesKey c : SQLHintPropertiesKey.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SQLHintPropertiesKey valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null