net.ilexiconn.llibrary.server.property

Interface IBooleanProperty

All Known Implementing Classes:

BooleanConfigProperty, BooleanPropertyWrapper, IBooleanProperty.WithState

public interface IBooleanProperty

A boolean property which has a set of valid values.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IBooleanProperty.WithState A simple implementation that holds its own state.

Method Summary

Modifier and Type	Method and Description
boolean	getBoolean() Get the boolean value.
boolean	isValidBoolean(boolean value) Returns true if the boolean value is valid.
void	setBoolean(boolean value) Set the boolean value, regardless of it being a valid value or not.
default boolean	trySetBoolean(boolean value) Try to set the boolean value.

Method Detail

getBoolean

boolean getBoolean()

Get the boolean value.

Returns:

the boolean value

setBoolean

void setBoolean(boolean value)

Set the boolean value, regardless of it being a valid value or not. The validity of the boolean value should be evaluated with isValidBoolean.

Parameters:

value - the boolean value

isValidBoolean

boolean isValidBoolean(boolean value)

Returns true if the boolean value is valid.

Parameters:

value - the boolean value

Returns:

true if the boolean value is valid

trySetBoolean

default boolean trySetBoolean(boolean value)

Try to set the boolean value. Returns true if it succeeded.

Parameters:

value - the boolean value

Returns:

true if it succeeded