Class StringType

java.lang.Object

net.ixdarklord.coolcatcore.api.config.type.StringType

All Implemented Interfaces:

ConfigType<String>

public final class StringType
extends Object
implements ConfigType<String>

Text, optionally limited in length, required not to be empty, or matched against a pattern.

Method Summary

Modifier and Type	Method	Description
com.mojang.serialization.Codec<String>	codec()
List<net.minecraft.network.chat.Component>	describe()	The constraints in words, for the file's comments and the screen's tooltips ("Range: 0 ~ 10").
String	format(String value)	The value as a player would type it, the inverse of ConfigType.parse(String).
boolean	isNotEmpty()
int	maxLength()
ValidationResult<String>	parse(String text)	Reads a value typed by a player, and validates it.
@Nullable Pattern	pattern()
ValidationResult<String>	validate(String value)	Checks a value, possibly correcting it.
StringType	withMaxLength(int maxLength)
StringType	withNotEmpty(boolean notEmpty)
StringType	withPattern(@Nullable String regex)	The whole text must match the pattern.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ConfigType

equals, suggestions

Method Details

maxLength

public int maxLength()

isNotEmpty

public boolean isNotEmpty()

pattern

@Nullable
public @Nullable Pattern pattern()

withMaxLength

public StringType withMaxLength(int maxLength)

withNotEmpty

public StringType withNotEmpty(boolean notEmpty)

withPattern

public StringType withPattern(@Nullable
 @Nullable String regex)

The whole text must match the pattern.

codec

public com.mojang.serialization.Codec<String> codec()

Specified by:

codec in interface ConfigType<String>

validate

public ValidationResult<String> validate(String value)

Description copied from interface: ConfigType

Checks a value, possibly correcting it.

Specified by:

validate in interface ConfigType<String>

parse

public ValidationResult<String> parse(String text)

Description copied from interface: ConfigType

Reads a value typed by a player, and validates it. By default the text is JSON for the codec.

Specified by:

parse in interface ConfigType<String>

format

public String format(String value)

Description copied from interface: ConfigType

The value as a player would type it, the inverse of ConfigType.parse(String). By default compact JSON.

Specified by:

format in interface ConfigType<String>

describe

public List<net.minecraft.network.chat.Component> describe()

Description copied from interface: ConfigType

The constraints in words, for the file's comments and the screen's tooltips ("Range: 0 ~ 10").

Specified by:

describe in interface ConfigType<String>