tuweni / org.apache.tuweni.config / SchemaBuilder / addBoolean

addBoolean

fun addBoolean(key: String!, @Nullable defaultValue: Boolean?, @Nullable description: String?, @Nullable validator: PropertyValidator<in Boolean!>?): SchemaBuilder! (source)

Add a boolean property to the schema.

Even if no validator is provided, the schema will validate that the configuration property, if present, contains a boolean.

If a defaultValue is provided, then the provided validator, if any, will only be invoked if the value is present (i.e. it will not be provided a null value to validate).

Parameters

key - String!: The configuration property key.

defaultValue - Boolean?: A default value for the property or null if no default is provided.

description - String?: The description to associate with this property, or null if no documentation is provided.

validator - PropertyValidator<in Boolean!>?: A validator for the property, or null if no validator is provided.

Exceptions

IllegalArgumentException - If the key cannot be parsed.

Return
SchemaBuilder!: This builder.