Package net.darkhax.pricklemc.common.api.config.property

Class RegexStringProperty

java.lang.Object

net.darkhax.pricklemc.common.api.config.property.ObjectProperty<String>

net.darkhax.pricklemc.common.api.config.property.RegexStringProperty

All Implemented Interfaces:

IConfigProperty<String>

public class RegexStringProperty
extends ObjectProperty<String>

A property that holds a string that is validated using Regex.

Field Summary

Fields

Modifier and Type	Field	Description
static IPropertyAdapter<RegexStringProperty>	ADAPTER	A property adapter for regex validated strings.

Fields inherited from class net.darkhax.pricklemc.common.api.config.property.ObjectProperty

FALLBACK_ADAPTER

Method Summary

Modifier and Type	Method	Description
boolean	validate(String value)	Validates if a value is valid for the property.
void	writeAdditionalComments(com.google.gson.stream.JsonWriter writer, PropertyResolver resolver, org.slf4j.Logger log)	Writes additional decorators to the JSON writer.

Methods inherited from class net.darkhax.pricklemc.common.api.config.property.ObjectProperty

comment, defaultValue, read, readValue, value, write, writeDefaultValue, writeDefaultValue, writeValue

Methods inherited from class java.lang.Object

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

Field Details

ADAPTER

public static IPropertyAdapter<RegexStringProperty> ADAPTER

A property adapter for regex validated strings.

Method Details

writeAdditionalComments

public void writeAdditionalComments(com.google.gson.stream.JsonWriter writer,
 PropertyResolver resolver,
 org.slf4j.Logger log)
                             throws IOException

Description copied from class: ObjectProperty

Writes additional decorators to the JSON writer.

Overrides:

writeAdditionalComments in class ObjectProperty<String>

Parameters:

writer - A writer to write JSON data to.

resolver - Resolves properties with GSON or config properties.

log - A log instance used to log warnings and errors encountered when saving the value.

Throws:

IOException - A fatal exception may be thrown if the decorators could not be written.

validate

public boolean validate(String value)
                 throws IllegalArgumentException

Description copied from interface: IConfigProperty

Validates if a value is valid for the property.

Specified by:

validate in interface IConfigProperty<String>

Overrides:

validate in class ObjectProperty<String>

Parameters:

value - The value to validate.

Returns:

If the value is true or not. Invalid properties will not be applied when reading the value from JSON.

Throws:

IllegalArgumentException - Generally a fatal exception should be raised when the value is invalid.