io.debezium.config

Class Field

java.lang.Object

io.debezium.config.Field

@Immutable
public final class Field
extends Object

An immutable definition of a field that make appear within a Configuration instance.

Author:

Randall Hauch

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Field.Validator A functional interface that can be used to validate field values.

Field Summary

Fields

Modifier and Type	Field and Description
private Supplier<String>	defaultValueGenerator
private String	desc
private String	name
private Field.Validator	validator

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Field(String name, String description, Supplier<String> defaultValueGenerator, Field.Validator validator)

Method Summary

Modifier and Type	Method and Description
static Field	create(String name) Create an immutable Field instance with the given property name.
static Field	create(String name, String description) Create an immutable Field instance with the given property name and description.
static Field	create(String name, String description, boolean defaultValue) Create an immutable Field instance with the given property name, description, and default value.
static Field	create(String name, String description, BooleanSupplier defaultValueGenerator) Create an immutable Field instance with the given property name, description, and default value.
static Field	create(String name, String description, int defaultValue) Create an immutable Field instance with the given property name, description, and default value.
static Field	create(String name, String description, IntSupplier defaultValueGenerator) Create an immutable Field instance with the given property name, description, and default value.
static Field	create(String name, String description, long defaultValue) Create an immutable Field instance with the given property name, description, and default value.
static Field	create(String name, String description, LongSupplier defaultValueGenerator) Create an immutable Field instance with the given property name, description, and default value.
static Field	create(String name, String description, String defaultValue) Create an immutable Field instance with the given property name, description, and default value.
static Field	create(String name, String description, Supplier<String> defaultValueGenerator) Create an immutable Field instance with the given property name, description, and default value.
String	defaultValue() Get the default value of the field.
String	description() Get the description of the field.
boolean	equals(Object obj)
int	hashCode()
static int	isBoolean(Configuration config, Field field, Consumer<String> problems)
static int	isClassName(Configuration config, Field field, Consumer<String> problems)
static int	isInteger(Configuration config, Field field, Consumer<String> problems)
static int	isLong(Configuration config, Field field, Consumer<String> problems)
static int	isNonNegativeInteger(Configuration config, Field field, Consumer<String> problems)
static int	isNonNegativeLong(Configuration config, Field field, Consumer<String> problems)
static int	isPositiveInteger(Configuration config, Field field, Consumer<String> problems)
static int	isPositiveLong(Configuration config, Field field, Consumer<String> problems)
static int	isRequired(Configuration config, Field field, Consumer<String> problems)
String	name() Get the name of the field.
String	toString()
boolean	validate(Configuration config, Consumer<String> problems) Validate the supplied value for this field, and report any problems to the designated consumer.
Field	withDefault(boolean defaultValue) Create and return a new Field instance that is a copy of this field but with the given default value.
Field	withDefault(BooleanSupplier defaultValueGenerator) Create and return a new Field instance that is a copy of this field but with the given default value.
Field	withDefault(int defaultValue) Create and return a new Field instance that is a copy of this field but with the given default value.
Field	withDefault(IntSupplier defaultValueGenerator) Create and return a new Field instance that is a copy of this field but with the given default value.
Field	withDefault(long defaultValue) Create and return a new Field instance that is a copy of this field but with the given default value.
Field	withDefault(LongSupplier defaultValueGenerator) Create and return a new Field instance that is a copy of this field but with the given default value.
Field	withDefault(String defaultValue) Create and return a new Field instance that is a copy of this field but with the given default value.
Field	withDescription(String description) Create and return a new Field instance that is a copy of this field but with the given description.
Field	withNoValidation() Create and return a new Field instance that is a copy of this field but that uses no validation.
Field	withValidation(Field.Validator... validators) Create and return a new Field instance that is a copy of this field but that uses the supplied validation function during validate(Configuration, Consumer).
Field	withValidation(Function<String,?>... conversionCheck) Create and return a new Field instance that is a copy of this field but that uses the supplied conversion check function during validate(Configuration, Consumer).
Field	withValidation(Predicate<String>... predicates) Create and return a new Field instance that that is a copy of this field but that uses the supplied predicate during validate(Configuration, Consumer).

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

name

private final String name

desc

private final String desc

defaultValueGenerator

private final Supplier<String> defaultValueGenerator

validator

private final Field.Validator validator

Constructor Detail

Field

protected Field(String name,
                String description,
                Supplier<String> defaultValueGenerator,
                Field.Validator validator)

Method Detail

create

public static Field create(String name)

Create an immutable Field instance with the given property name.

Parameters:

name - the name of the field; may not be null

Returns:

the field; never null

create

public static Field create(String name,
                           String description)

Create an immutable Field instance with the given property name and description.

Parameters:

name - the name of the field; may not be null

description - the description

Returns:

the field; never null

create

public static Field create(String name,
                           String description,
                           String defaultValue)

Create an immutable Field instance with the given property name, description, and default value.

Parameters:

name - the name of the field; may not be null

description - the description

defaultValue - the default value for the field

Returns:

the field; never null

create

public static Field create(String name,
                           String description,
                           int defaultValue)

Create an immutable Field instance with the given property name, description, and default value.

Parameters:

name - the name of the field; may not be null

description - the description

defaultValue - the default value for the field

Returns:

the field; never null

create

public static Field create(String name,
                           String description,
                           long defaultValue)

Create an immutable Field instance with the given property name, description, and default value.

Parameters:

name - the name of the field; may not be null

description - the description

defaultValue - the default value for the field

Returns:

the field; never null

create

public static Field create(String name,
                           String description,
                           boolean defaultValue)

Create an immutable Field instance with the given property name, description, and default value.

Parameters:

name - the name of the field; may not be null

description - the description

defaultValue - the default value for the field

Returns:

the field; never null

create

public static Field create(String name,
                           String description,
                           Supplier<String> defaultValueGenerator)

Create an immutable Field instance with the given property name, description, and default value.

Parameters:

name - the name of the field; may not be null

description - the description

defaultValueGenerator - the generator for the default value for the field

Returns:

the field; never null

create

public static Field create(String name,
                           String description,
                           BooleanSupplier defaultValueGenerator)

Create an immutable Field instance with the given property name, description, and default value.

Parameters:

name - the name of the field; may not be null

description - the description

defaultValueGenerator - the generator for the default value for the field

Returns:

the field; never null

create

public static Field create(String name,
                           String description,
                           IntSupplier defaultValueGenerator)

Create an immutable Field instance with the given property name, description, and default value.

Parameters:

name - the name of the field; may not be null

description - the description

defaultValueGenerator - the generator for the default value for the field

Returns:

the field; never null

create

public static Field create(String name,
                           String description,
                           LongSupplier defaultValueGenerator)

Create an immutable Field instance with the given property name, description, and default value.

Parameters:

name - the name of the field; may not be null

description - the description

defaultValueGenerator - the generator for the default value for the field

Returns:

the field; never null

name

public String name()

Get the name of the field.

Returns:

the name; never null

defaultValue

public String defaultValue()

Get the default value of the field.

Returns:

the default value as a string; never null

description

public String description()

Get the description of the field.

Returns:

the description; never null

validate

public boolean validate(Configuration config,
                        Consumer<String> problems)

Validate the supplied value for this field, and report any problems to the designated consumer.

Parameters:

config - the field values keyed by their name; may not be null

problems - the consumer to be called with each problem; never null

Returns:

true if the value is considered valid, or false if it is not valid

withDescription

public Field withDescription(String description)

Create and return a new Field instance that is a copy of this field but with the given description.

Parameters:

description - the new description for the new field

Returns:

the new field; never null

withDefault

public Field withDefault(String defaultValue)

Create and return a new Field instance that is a copy of this field but with the given default value.

Parameters:

defaultValue - the new default value for the new field

Returns:

the new field; never null

withDefault

public Field withDefault(boolean defaultValue)

Create and return a new Field instance that is a copy of this field but with the given default value.

Parameters:

defaultValue - the new default value for the new field

Returns:

the new field; never null

withDefault

public Field withDefault(int defaultValue)

Create and return a new Field instance that is a copy of this field but with the given default value.

Parameters:

defaultValue - the new default value for the new field

Returns:

the new field; never null

withDefault

public Field withDefault(long defaultValue)

Create and return a new Field instance that is a copy of this field but with the given default value.

Parameters:

defaultValue - the new default value for the new field

Returns:

the new field; never null

withDefault

public Field withDefault(BooleanSupplier defaultValueGenerator)

Create and return a new Field instance that is a copy of this field but with the given default value.

Parameters:

defaultValueGenerator - the supplier for the new default value for the new field, called whenever a default value is needed

Returns:

the new field; never null

withDefault

public Field withDefault(IntSupplier defaultValueGenerator)

Create and return a new Field instance that is a copy of this field but with the given default value.

Parameters:

defaultValueGenerator - the supplier for the new default value for the new field, called whenever a default value is needed

Returns:

the new field; never null

withDefault

public Field withDefault(LongSupplier defaultValueGenerator)

Create and return a new Field instance that is a copy of this field but with the given default value.

Parameters:

defaultValueGenerator - the supplier for the new default value for the new field, called whenever a default value is needed

Returns:

the new field; never null

withNoValidation

public Field withNoValidation()

Create and return a new Field instance that is a copy of this field but that uses no validation.

Returns:

the new field; never null

withValidation

public Field withValidation(Field.Validator... validators)

Create and return a new Field instance that is a copy of this field but that uses the supplied validation function during validate(Configuration, Consumer).

Parameters:

validators - the validation function(s); may be null

Returns:

the new field; never null

withValidation

public Field withValidation(Function<String,?>... conversionCheck)

Create and return a new Field instance that is a copy of this field but that uses the supplied conversion check function during validate(Configuration, Consumer).

Parameters:

conversionCheck - the functions that attempt to validate the object; may be null

Returns:

the new field; never null

withValidation

public Field withValidation(Predicate<String>... predicates)

Create and return a new Field instance that that is a copy of this field but that uses the supplied predicate during validate(Configuration, Consumer).

Parameters:

predicates - the functions that attempt to validate the object; may be null

Returns:

the new field; never null

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

isClassName

public static int isClassName(Configuration config,
                              Field field,
                              Consumer<String> problems)

isRequired

public static int isRequired(Configuration config,
                             Field field,
                             Consumer<String> problems)

isBoolean

public static int isBoolean(Configuration config,
                            Field field,
                            Consumer<String> problems)

isInteger

public static int isInteger(Configuration config,
                            Field field,
                            Consumer<String> problems)

isPositiveInteger

public static int isPositiveInteger(Configuration config,
                                    Field field,
                                    Consumer<String> problems)

isNonNegativeInteger

public static int isNonNegativeInteger(Configuration config,
                                       Field field,
                                       Consumer<String> problems)

isLong

public static int isLong(Configuration config,
                         Field field,
                         Consumer<String> problems)

isPositiveLong

public static int isPositiveLong(Configuration config,
                                 Field field,
                                 Consumer<String> problems)

isNonNegativeLong

public static int isNonNegativeLong(Configuration config,
                                    Field field,
                                    Consumer<String> problems)