tuweni / org.apache.tuweni.toml / TomlTable / getBoolean

getBoolean

@Nullable open fun getBoolean(dottedKey: String!): Boolean? (source)

Get a boolean from the TOML document.

Parameters

dottedKey - String!: A dotted key (e.g. "server.address.port").

Exceptions

IllegalArgumentException - If the key cannot be parsed.

TomlInvalidTypeException - If the value is present but not a boolean, or any element of the path preceding the final key is not a table.

Return
Boolean?: The value, or null if no value was set in the TOML document.

@Nullable open fun getBoolean(path: MutableList<String!>!): Boolean? (source)

Get a boolean from the TOML document.

Parameters

path - MutableList<String!>!: The key path.

Exceptions

TomlInvalidTypeException - If the value is present but not a boolean, or any element of the path preceding the final key is not a table.

Return
Boolean?: The value, or null if no value was set in the TOML document.

open fun getBoolean(dottedKey: String!, defaultValue: BooleanSupplier!): Boolean (source)

Get a boolean from the TOML document, or return a default.

Parameters

dottedKey - String!: A dotted key (e.g. "server.address.port").

defaultValue - BooleanSupplier!: A supplier for the default value.

Exceptions

IllegalArgumentException - If the key cannot be parsed.

TomlInvalidTypeException - If the value is present but not a boolean, or any element of the path preceding the final key is not a table.

Return
Boolean: The value, or the default.

open fun getBoolean(path: MutableList<String!>!, defaultValue: BooleanSupplier!): Boolean (source)

Get a boolean from the TOML document, or return a default.

Parameters

path - MutableList<String!>!: The key path.

defaultValue - BooleanSupplier!: A supplier for the default value.

Exceptions

TomlInvalidTypeException - If the value is present but not a boolean, or any element of the path preceding the final key is not a table.

Return
Boolean: The value, or the default.