Package org.apache.calcite.avatica.remote

Enum AvaticaRemoteConnectionProperty

java.lang.Object

java.lang.Enum<AvaticaRemoteConnectionProperty>

org.apache.calcite.avatica.remote.AvaticaRemoteConnectionProperty

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AvaticaRemoteConnectionProperty>, ConnectionProperty

public enum AvaticaRemoteConnectionProperty
extends java.lang.Enum<AvaticaRemoteConnectionProperty>
implements ConnectionProperty

Enumeration of Avatica remote driver's built-in connection properties.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.calcite.avatica.ConnectionProperty

ConnectionProperty.Type

Enum Constant Summary

Enum Constants

Enum Constant	Description
FACTORY	Factory.

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	camelName
private java.lang.Object	defaultValue
private static java.util.Map<java.lang.String,AvaticaRemoteConnectionProperty>	NAME_TO_PROPS
private ConnectionProperty.Type	type

Constructor Summary

Constructors

Modifier	Constructor	Description
private	AvaticaRemoteConnectionProperty(java.lang.String camelName, ConnectionProperty.Type type, java.lang.Object defaultValue)

Method Summary

Modifier and Type	Method	Description
java.lang.String	camelName()	The name of this property in camel-case.
java.lang.Object	defaultValue()	Returns the default value of this property.
boolean	required()	Whether the property is mandatory.
ConnectionProperty.Type	type()	Returns the data type of this property.
java.lang.Class	valueClass()	Class of values that this property can take.
static AvaticaRemoteConnectionProperty	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static AvaticaRemoteConnectionProperty[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.
ConnectionConfigImpl.PropEnv	wrap(java.util.Properties properties)	Wraps this property with a properties object from which its value can be obtained when needed.

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.calcite.avatica.ConnectionProperty

name

Enum Constant Detail

FACTORY

public static final AvaticaRemoteConnectionProperty FACTORY

Factory.

Field Detail

camelName

private final java.lang.String camelName

type

private final ConnectionProperty.Type type

defaultValue

private final java.lang.Object defaultValue

NAME_TO_PROPS

private static final java.util.Map<java.lang.String,AvaticaRemoteConnectionProperty> NAME_TO_PROPS

Constructor Detail

AvaticaRemoteConnectionProperty

private AvaticaRemoteConnectionProperty(java.lang.String camelName,
                                        ConnectionProperty.Type type,
                                        java.lang.Object defaultValue)

Method Detail

values

public static AvaticaRemoteConnectionProperty[] 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 (AvaticaRemoteConnectionProperty c : AvaticaRemoteConnectionProperty.values())
    System.out.println(c);

Returns:

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

valueOf

public static AvaticaRemoteConnectionProperty valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

camelName

public java.lang.String camelName()

Description copied from interface: ConnectionProperty

The name of this property in camel-case. (E.g. "materializationsEnabled".)

Specified by:

camelName in interface ConnectionProperty

defaultValue

public java.lang.Object defaultValue()

Description copied from interface: ConnectionProperty

Returns the default value of this property. The type must match its data type.

Specified by:

defaultValue in interface ConnectionProperty

type

public ConnectionProperty.Type type()

Description copied from interface: ConnectionProperty

Returns the data type of this property.

Specified by:

type in interface ConnectionProperty

valueClass

public java.lang.Class valueClass()

Description copied from interface: ConnectionProperty

Class of values that this property can take. Most useful for ConnectionProperty.Type.ENUM properties.

Specified by:

valueClass in interface ConnectionProperty

wrap

public ConnectionConfigImpl.PropEnv wrap(java.util.Properties properties)

Description copied from interface: ConnectionProperty

Wraps this property with a properties object from which its value can be obtained when needed.

Specified by:

wrap in interface ConnectionProperty

required

public boolean required()

Description copied from interface: ConnectionProperty

Whether the property is mandatory.

Specified by:

required in interface ConnectionProperty