software.amazon.jdbc

Class AwsWrapperProperty

java.lang.Object

java.sql.DriverPropertyInfo

software.amazon.jdbc.AwsWrapperProperty

public class AwsWrapperProperty
extends java.sql.DriverPropertyInfo

Field Summary

Fields

Modifier and Type	Field and Description
@Nullable java.lang.String	defaultValue

Fields inherited from class java.sql.DriverPropertyInfo

choices, description, name, required, value

Constructor Summary

Constructors

Constructor and Description
AwsWrapperProperty(@NonNull java.lang.String name, @Nullable java.lang.String defaultValue, java.lang.String description)
AwsWrapperProperty(@NonNull java.lang.String name, @Nullable java.lang.String defaultValue, java.lang.String description, boolean required)
AwsWrapperProperty(@NonNull java.lang.String name, @Nullable java.lang.String defaultValue, java.lang.String description, boolean required, java.lang.String[] choices)

Method Summary

Modifier and Type	Method and Description
boolean	getBoolean(java.util.Properties properties)
@Nullable java.lang.String[]	getChoices()
int	getInteger(java.util.Properties properties)
long	getLong(java.util.Properties properties)
@Nullable java.lang.String	getString(java.util.Properties properties)
AwsWrapperProperty	nonNegative() Marks this property as not allowing negative values.
void	set(java.util.Properties properties, @Nullable java.lang.String value)
java.sql.DriverPropertyInfo	toDriverPropertyInfo(java.util.Properties properties)
AwsWrapperProperty	withBounds(@Nullable java.lang.Long min, @Nullable java.lang.Long max) Declares inclusive bounds for this property's numeric value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

defaultValue

public final @Nullable java.lang.String defaultValue

Constructor Detail

AwsWrapperProperty

public AwsWrapperProperty(@NonNull java.lang.String name,
                          @Nullable java.lang.String defaultValue,
                          java.lang.String description)

AwsWrapperProperty

public AwsWrapperProperty(@NonNull java.lang.String name,
                          @Nullable java.lang.String defaultValue,
                          java.lang.String description,
                          boolean required)

AwsWrapperProperty

public AwsWrapperProperty(@NonNull java.lang.String name,
                          @Nullable java.lang.String defaultValue,
                          java.lang.String description,
                          boolean required,
                          java.lang.String[] choices)

Method Detail

withBounds

public AwsWrapperProperty withBounds(@Nullable java.lang.Long min,
                                     @Nullable java.lang.Long max)

Declares inclusive bounds for this property's numeric value. The bounds are validated whenever the value is read via getInteger(Properties) or getLong(Properties); a value outside the range causes an IllegalArgumentException to be thrown (fail-fast).

Parameters:

min - the inclusive minimum allowed value, or null for no lower bound.

max - the inclusive maximum allowed value, or null for no upper bound.

Returns:

this property, to allow fluent declaration.

nonNegative

public AwsWrapperProperty nonNegative()

Marks this property as not allowing negative values. Intended for timeouts, expiration times, intervals, and other durations that are meaningless when negative.

Returns:

this property, to allow fluent declaration.

getString

public @Nullable java.lang.String getString(java.util.Properties properties)

getBoolean

public boolean getBoolean(java.util.Properties properties)

getInteger

public int getInteger(java.util.Properties properties)

getLong

public long getLong(java.util.Properties properties)

set

public void set(java.util.Properties properties,
                @Nullable java.lang.String value)

getChoices

public @Nullable java.lang.String[] getChoices()

toDriverPropertyInfo

public java.sql.DriverPropertyInfo toDriverPropertyInfo(java.util.Properties properties)