Class EntryValidator

java.lang.Object

org.skriptlang.skript.lang.entry.EntryValidator

public class EntryValidator
extends Object

A validator for storing EntryData. It can be used to validate whether a SectionNode contains the required entries. This validation process will return an EntryContainer for accessing entry values.

See Also:

• EntryValidator.EntryValidatorBuilder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EntryValidator.EntryValidatorBuilder	A utility builder for creating an entry validator that can be used to parse and validate a SectionNode.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EntryValidator(List<EntryData<?>> entryData, @Nullable Predicate<Node> unexpectedNodeTester, @Nullable Function<String,String> unexpectedEntryMessage, @Nullable Function<String,String> missingRequiredEntryMessage)

Method Summary

Modifier and Type	Method	Description
static EntryValidator.EntryValidatorBuilder	builder()
List<EntryData<?>>	getEntryData()
Function<String,String>	getMissingRequiredEntryMessage()
Function<String,String>	getUnexpectedEntryMessage()
@Nullable Predicate<Node>	getUnexpectedNodeTester()
@Nullable EntryContainer	validate(SectionNode sectionNode)	Validates a node using this entry validator.

Methods inherited from class Object

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

Constructor Details

EntryValidator

protected EntryValidator(List<EntryData<?>> entryData,
 @Nullable
 @Nullable Predicate<Node> unexpectedNodeTester,
 @Nullable
 @Nullable Function<String,String> unexpectedEntryMessage,
 @Nullable
 @Nullable Function<String,String> missingRequiredEntryMessage)

Method Details

builder

public static EntryValidator.EntryValidatorBuilder builder()

Returns:

A builder to be used for creating an EntryValidator.

getEntryData

public List<EntryData<?>> getEntryData()

Returns:

An unmodifiable list containing all EntryData of this validator.

getUnexpectedNodeTester

@Nullable
public @Nullable Predicate<Node> getUnexpectedNodeTester()

Returns:

A predicate that tests whether a node not explicitly handled by any getEntryData() should be allowed to be present.

getUnexpectedEntryMessage

public Function<String,String> getUnexpectedEntryMessage()

Returns:

A function that creates an error message from the key of an unexpected entry when one is encountered during validation.

getMissingRequiredEntryMessage

public Function<String,String> getMissingRequiredEntryMessage()

Returns:

A function that creates an error message from the key of an entry missing during validation.

validate

@Nullable
public @Nullable EntryContainer validate(SectionNode sectionNode)

Validates a node using this entry validator.

Parameters:

sectionNode - The node to validate.

Returns:

An entry container holding the validated nodes along with any additional nodes (if permitted by getUnexpectedNodeTester()). Will return null if the provided node couldn't be validated.