ch.jalu.configme.properties

Class RegexProperty

java.lang.Object

ch.jalu.configme.properties.BaseProperty<Pattern>

ch.jalu.configme.properties.RegexProperty

All Implemented Interfaces:

Property<Pattern>

public class RegexProperty
extends BaseProperty<Pattern>

Property whose value is a regex pattern.

Constructor Summary

Constructors

Constructor and Description
RegexProperty(@NotNull String path, @NotNull Pattern defaultValue) Constructor.
RegexProperty(@NotNull String path, @NotNull String defaultRegexValue) Constructor.

Method Summary

Modifier and Type	Method and Description
protected @Nullable Pattern	getFromReader(@NotNull PropertyReader reader, @NotNull ConvertErrorRecorder errorRecorder) Constructs the value of the property from the property reader.
boolean	matches(@NotNull String value, @NotNull SettingsManager settingsManager) Convenience method to evaluate whether the pattern set for this property matches the provided value.
@NotNull Object	toExportValue(@NotNull Pattern value) Converts the given value to a representation that is suitable for exporting by a property resource.

Methods inherited from class ch.jalu.configme.properties.BaseProperty

determineValue, getDefaultValue, getPath, isValidValue, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.jalu.configme.properties.Property

isValidInResource

Constructor Detail

RegexProperty

public RegexProperty(@NotNull
                     @NotNull String path,
                     @NotNull
                     @NotNull Pattern defaultValue)

Constructor.

Parameters:

path - the path of the property

defaultValue - the default value of the property

RegexProperty

public RegexProperty(@NotNull
                     @NotNull String path,
                     @NotNull
                     @NotNull String defaultRegexValue)

Constructor.

Parameters:

path - the path of the property

defaultRegexValue - the default value of the property

Method Detail

getFromReader

@Nullable
protected @Nullable Pattern getFromReader(@NotNull
                                                    @NotNull PropertyReader reader,
                                                    @NotNull
                                                    @NotNull ConvertErrorRecorder errorRecorder)

Description copied from class: BaseProperty

Constructs the value of the property from the property reader. Returns null if no value is available in the reader or if it cannot be used to construct a value for this property.

Specified by:

getFromReader in class BaseProperty<Pattern>

Parameters:

reader - the reader to read from

errorRecorder - error recorder to register errors even if a valid value is returned

Returns:

value based on the reader, or null if not applicable

toExportValue

@NotNull
public @NotNull Object toExportValue(@NotNull
                                              @NotNull Pattern value)

Description copied from interface: Property

Converts the given value to a representation that is suitable for exporting by a property resource. The return value should contain the data in the given value represented with only basic types (String, Number, Boolean), as well as lists and maps thereof.

The values which are suitable for returning depend on the support of the used property resource. By default, the supported types include null, String, Integer, Double, Boolean; Collection of the aforementioned types; Map with String keys and values of any of the aforementioned types. Maps and collections can be nested at any arbitrary level. Null signifies that the property/value should be skipped in the export.

Parameters:

value - the value to convert to an export value

Returns:

value to use for export, null to skip the property

matches

public boolean matches(@NotNull
                       @NotNull String value,
                       @NotNull
                       @NotNull SettingsManager settingsManager)

Convenience method to evaluate whether the pattern set for this property matches the provided value.

Parameters:

value - the value to check whether it conforms to the configured pattern

settingsManager - settings manager with which the configured pattern is retrieved

Returns:

true if the value matches the pattern, false otherwise