Package io.trino.spi.session

Class PropertyMetadata<T>

java.lang.Object

io.trino.spi.session.PropertyMetadata<T>

public final class PropertyMetadata<T>
extends Object

Constructor Summary

Constructors

Constructor	Description
PropertyMetadata(String name, String description, Type sqlType, Class<T> javaType, T defaultValue, boolean hidden, Function<Object,T> decoder, Function<T,Object> encoder)

Method Summary

Modifier and Type	Method	Description
static PropertyMetadata<Boolean>	booleanProperty(String name, String description, Boolean defaultValue, boolean hidden)
static PropertyMetadata<Boolean>	booleanProperty(String name, String description, Boolean defaultValue, Consumer<Boolean> validation, boolean hidden)
T	decode(Object value)	Decodes the SQL type object value to the Java type of the property.
static PropertyMetadata<Double>	doubleProperty(String name, String description, Double defaultValue, boolean hidden)
static PropertyMetadata<Double>	doubleProperty(String name, String description, Double defaultValue, Consumer<Double> validation, boolean hidden)
Object	encode(T value)	Encodes the Java type value to SQL type object value
static <T extends Enum<T>> PropertyMetadata<T>	enumProperty(String name, String descriptionPrefix, Class<T> type, T defaultValue, boolean hidden)
static <T extends Enum<T>> PropertyMetadata<T>	enumProperty(String name, String descriptionPrefix, Class<T> type, T defaultValue, Consumer<T> validation, boolean hidden)
T	getDefaultValue()	Gets the default value for this property.
String	getDescription()	Description for the end user.
Class<T>	getJavaType()	Java type of this property.
String	getName()	Name of the property.
Type	getSqlType()	SQL type of the property.
static PropertyMetadata<Integer>	integerProperty(String name, String description, Integer defaultValue, boolean hidden)
static PropertyMetadata<Integer>	integerProperty(String name, String description, Integer defaultValue, Consumer<Integer> validation, boolean hidden)
boolean	isHidden()	Is this property hidden from users?
static PropertyMetadata<Long>	longProperty(String name, String description, Long defaultValue, boolean hidden)
static PropertyMetadata<Long>	longProperty(String name, String description, Long defaultValue, Consumer<Long> validation, boolean hidden)
static PropertyMetadata<String>	stringProperty(String name, String description, String defaultValue, boolean hidden)
static PropertyMetadata<String>	stringProperty(String name, String description, String defaultValue, Consumer<String> validation, boolean hidden)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

PropertyMetadata

public PropertyMetadata(String name,
 String description,
 Type sqlType,
 Class<T> javaType,
 T defaultValue,
 boolean hidden,
 Function<Object,T> decoder,
 Function<T,Object> encoder)

Method Details

getName

public String getName()

Name of the property. This must be a valid identifier.

getDescription

public String getDescription()

Description for the end user.

getSqlType

public Type getSqlType()

SQL type of the property.

getJavaType

public Class<T> getJavaType()

Java type of this property.

getDefaultValue

public T getDefaultValue()

Gets the default value for this property.

isHidden

public boolean isHidden()

Is this property hidden from users?

decode

public T decode(Object value)

Decodes the SQL type object value to the Java type of the property.

encode

public Object encode(T value)

Encodes the Java type value to SQL type object value

toString

public String toString()

Overrides:

toString in class Object

booleanProperty

public static PropertyMetadata<Boolean> booleanProperty(String name,
 String description,
 Boolean defaultValue,
 boolean hidden)

booleanProperty

public static PropertyMetadata<Boolean> booleanProperty(String name,
 String description,
 Boolean defaultValue,
 Consumer<Boolean> validation,
 boolean hidden)

integerProperty

public static PropertyMetadata<Integer> integerProperty(String name,
 String description,
 Integer defaultValue,
 boolean hidden)

integerProperty

public static PropertyMetadata<Integer> integerProperty(String name,
 String description,
 Integer defaultValue,
 Consumer<Integer> validation,
 boolean hidden)

longProperty

public static PropertyMetadata<Long> longProperty(String name,
 String description,
 Long defaultValue,
 boolean hidden)

longProperty

public static PropertyMetadata<Long> longProperty(String name,
 String description,
 Long defaultValue,
 Consumer<Long> validation,
 boolean hidden)

doubleProperty

public static PropertyMetadata<Double> doubleProperty(String name,
 String description,
 Double defaultValue,
 boolean hidden)

doubleProperty

public static PropertyMetadata<Double> doubleProperty(String name,
 String description,
 Double defaultValue,
 Consumer<Double> validation,
 boolean hidden)

stringProperty

public static PropertyMetadata<String> stringProperty(String name,
 String description,
 String defaultValue,
 boolean hidden)

stringProperty

public static PropertyMetadata<String> stringProperty(String name,
 String description,
 String defaultValue,
 Consumer<String> validation,
 boolean hidden)

enumProperty

public static <T extends Enum<T>>
PropertyMetadata<T> enumProperty(String name,
 String descriptionPrefix,
 Class<T> type,
 T defaultValue,
 boolean hidden)

enumProperty

public static <T extends Enum<T>>
PropertyMetadata<T> enumProperty(String name,
 String descriptionPrefix,
 Class<T> type,
 T defaultValue,
 Consumer<T> validation,
 boolean hidden)