net.ilexiconn.llibrary.server.property

Interface IStringProperty

All Known Subinterfaces:

IStringSelectionProperty

All Known Implementing Classes:

BooleanPropertyWrapper, DoublePropertyWrapper, DoublePropertyWrapperBase, DoubleRangePropertyWrapper, FloatPropertyWrapper, FloatPropertyWrapperBase, FloatRangePropertyWrapper, IntPropertyWrapper, IntPropertyWrapperBase, IntRangePropertyWrapper, IStringProperty.WithState, IStringSelectionProperty.WithState, StringConfigProperty, StringConfigPropertyBase, StringSelectionConfigProperty

public interface IStringProperty

A string property which has a set of valid values.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getString() Get the string value.
boolean	isValidString(java.lang.String value) Returns true if the string value is valid.
void	setString(java.lang.String value) Set the string value, regardless of it being a valid value or not.
default boolean	trySetString(java.lang.String value) Try to set the string value.

Method Detail

getString

java.lang.String getString()

Get the string value.

Returns:

the string value

setString

void setString(java.lang.String value)

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

Parameters:

value - the string value

isValidString

boolean isValidString(java.lang.String value)

Returns true if the string value is valid.

Parameters:

value - the string value

Returns:

true if the string value is valid

trySetString

default boolean trySetString(java.lang.String value)

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

Parameters:

value - the string value

Returns:

true if it succeeded