io.trino.spi.session.PropertyMetadata Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of trino-spi Show documentation
Show all versions of trino-spi Show documentation
Trino - Service Provider Interface (SPI)
/*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.trino.spi.session;
import io.trino.spi.type.Type;
import java.util.EnumSet;
import java.util.function.Consumer;
import java.util.function.Function;
import static io.trino.spi.type.BigintType.BIGINT;
import static io.trino.spi.type.BooleanType.BOOLEAN;
import static io.trino.spi.type.DoubleType.DOUBLE;
import static io.trino.spi.type.IntegerType.INTEGER;
import static io.trino.spi.type.VarcharType.VARCHAR;
import static io.trino.spi.type.VarcharType.createUnboundedVarcharType;
import static java.lang.String.format;
import static java.util.Locale.ENGLISH;
import static java.util.Objects.requireNonNull;
import static java.util.stream.Collectors.joining;
public final class PropertyMetadata
{
private final String name;
private final String description;
private final Type sqlType;
private final Class javaType;
private final T defaultValue;
private final boolean hidden;
private final Function decoder;
private final Function encoder;
public PropertyMetadata(
String name,
String description,
Type sqlType,
Class javaType,
T defaultValue,
boolean hidden,
Function decoder,
Function encoder)
{
requireNonNull(name, "name is null");
requireNonNull(description, "description is null");
requireNonNull(sqlType, "sqlType is null");
requireNonNull(javaType, "javaType is null");
requireNonNull(decoder, "decoder is null");
requireNonNull(encoder, "encoder is null");
if (name.isEmpty() || !name.trim().toLowerCase(ENGLISH).equals(name) || name.contains(".")) {
throw new IllegalArgumentException(format("Invalid property name '%s'", name));
}
if (description.isEmpty() || !description.trim().equals(description)) {
throw new IllegalArgumentException(format("Invalid property description '%s'", description));
}
this.name = name;
this.description = description;
this.javaType = javaType;
this.sqlType = sqlType;
this.defaultValue = defaultValue;
this.hidden = hidden;
this.decoder = decoder;
this.encoder = encoder;
}
/**
* Name of the property. This must be a valid identifier.
*/
public String getName()
{
return name;
}
/**
* Description for the end user.
*/
public String getDescription()
{
return description;
}
/**
* SQL type of the property.
*/
public Type getSqlType()
{
return sqlType;
}
/**
* Java type of this property.
*/
public Class getJavaType()
{
return javaType;
}
/**
* Gets the default value for this property.
*/
public T getDefaultValue()
{
return defaultValue;
}
/**
* Is this property hidden from users?
*/
public boolean isHidden()
{
return hidden;
}
/**
* Decodes the SQL type object value to the Java type of the property.
*/
public T decode(Object value)
{
return decoder.apply(value);
}
/**
* Encodes the Java type value to SQL type object value
*/
public Object encode(T value)
{
return encoder.apply(value);
}
@Override
public String toString()
{
return "PropertyMetadata{" + name + "}";
}
public static PropertyMetadata booleanProperty(String name, String description, Boolean defaultValue, boolean hidden)
{
return booleanProperty(name, description, defaultValue, value -> {}, hidden);
}
public static PropertyMetadata booleanProperty(String name, String description, Boolean defaultValue, Consumer validation, boolean hidden)
{
return new PropertyMetadata<>(
name,
description,
BOOLEAN,
Boolean.class,
defaultValue,
hidden,
object -> {
boolean value = (Boolean) object;
validation.accept(value);
return value;
},
object -> object);
}
public static PropertyMetadata integerProperty(String name, String description, Integer defaultValue, boolean hidden)
{
return integerProperty(name, description, defaultValue, value -> {}, hidden);
}
public static PropertyMetadata integerProperty(String name, String description, Integer defaultValue, Consumer validation, boolean hidden)
{
return new PropertyMetadata<>(
name,
description,
INTEGER,
Integer.class,
defaultValue,
hidden,
object -> {
int value = (Integer) object;
validation.accept(value);
return value;
},
object -> object);
}
public static PropertyMetadata longProperty(String name, String description, Long defaultValue, boolean hidden)
{
return longProperty(name, description, defaultValue, value -> {}, hidden);
}
public static PropertyMetadata longProperty(String name, String description, Long defaultValue, Consumer validation, boolean hidden)
{
return new PropertyMetadata<>(
name,
description,
BIGINT,
Long.class,
defaultValue,
hidden,
object -> {
long value = (Long) object;
validation.accept(value);
return value;
},
object -> object);
}
public static PropertyMetadata doubleProperty(String name, String description, Double defaultValue, boolean hidden)
{
return doubleProperty(name, description, defaultValue, value -> {}, hidden);
}
public static PropertyMetadata doubleProperty(String name, String description, Double defaultValue, Consumer validation, boolean hidden)
{
return new PropertyMetadata<>(
name,
description,
DOUBLE,
Double.class,
defaultValue,
hidden,
object -> {
double value = (Double) object;
validation.accept(value);
return value;
},
object -> object);
}
public static PropertyMetadata stringProperty(String name, String description, String defaultValue, boolean hidden)
{
return stringProperty(name, description, defaultValue, value -> {}, hidden);
}
public static PropertyMetadata stringProperty(String name, String description, String defaultValue, Consumer validation, boolean hidden)
{
return new PropertyMetadata<>(
name,
description,
VARCHAR,
String.class,
defaultValue,
hidden,
object -> {
String value = (String) object;
validation.accept(value);
return value;
},
object -> object);
}
public static > PropertyMetadata enumProperty(String name, String descriptionPrefix, Class type, T defaultValue, boolean hidden)
{
return enumProperty(name, descriptionPrefix, type, defaultValue, value -> {}, hidden);
}
public static > PropertyMetadata enumProperty(String name, String descriptionPrefix, Class type, T defaultValue, Consumer validation, boolean hidden)
{
String allValues = EnumSet.allOf(type).stream()
.map(Enum::name)
.collect(joining(", ", "[", "]"));
return new PropertyMetadata<>(
name,
format("%s. Possible values: %s", descriptionPrefix, allValues),
createUnboundedVarcharType(),
type,
defaultValue,
hidden,
value -> {
T enumValue;
try {
enumValue = Enum.valueOf(type, ((String) value).toUpperCase(ENGLISH));
}
catch (IllegalArgumentException e) {
throw new IllegalArgumentException(format("Invalid value [%s]. Valid values: %s", value, allValues), e);
}
validation.accept(enumValue);
return enumValue;
},
Enum::name);
}
}