Package org.skriptlang.skript.lang.entry

Class ContainerEntryData

java.lang.Object

org.skriptlang.skript.lang.entry.EntryData<EntryContainer>

org.skriptlang.skript.lang.entry.ContainerEntryData

public class ContainerEntryData
extends EntryData<EntryContainer>

An entry data for handling a SectionNode as the root node of another EntryValidator. This enables nested entry data validation.

Constructor Summary

Constructors

Constructor	Description
ContainerEntryData(String key, boolean optional, boolean multiple, EntryValidator entryValidator)
ContainerEntryData(String key, boolean optional, boolean multiple, EntryValidator.EntryValidatorBuilder validatorBuilder)
ContainerEntryData(String key, boolean optional, EntryValidator entryValidator)
ContainerEntryData(String key, boolean optional, EntryValidator.EntryValidatorBuilder validatorBuilder)

Method Summary

Modifier and Type	Method	Description
boolean	canCreateWith(Node node)	A method to be implemented by all entry data classes that determines whether the provided node may be used with the entry data type to obtain a value.
EntryValidator	getEntryValidator()
@Nullable EntryContainer	getValue(Node node)	Obtains a value from the provided node using the methods of this entry data.

Methods inherited from class org.skriptlang.skript.lang.entry.EntryData

getDefaultValue, getKey, isOptional, supportsMultiple

Methods inherited from class java.lang.Object

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

Constructor Details

ContainerEntryData

public ContainerEntryData(String key,
 boolean optional,
 EntryValidator entryValidator)

ContainerEntryData

public ContainerEntryData(String key,
 boolean optional,
 EntryValidator.EntryValidatorBuilder validatorBuilder)

ContainerEntryData

public ContainerEntryData(String key,
 boolean optional,
 boolean multiple,
 EntryValidator entryValidator)

ContainerEntryData

public ContainerEntryData(String key,
 boolean optional,
 boolean multiple,
 EntryValidator.EntryValidatorBuilder validatorBuilder)

Method Details

getEntryValidator

public EntryValidator getEntryValidator()

getValue

@Nullable
public @Nullable EntryContainer getValue(Node node)

Description copied from class: EntryData

Obtains a value from the provided node using the methods of this entry data.

Specified by:

getValue in class EntryData<EntryContainer>

Parameters:

node - The node to obtain a value from.

Returns:

The value obtained from the provided node.

canCreateWith

public boolean canCreateWith(Node node)

Description copied from class: EntryData

A method to be implemented by all entry data classes that determines whether the provided node may be used with the entry data type to obtain a value.

Specified by:

canCreateWith in class EntryData<EntryContainer>

Parameters:

node - The node to check.

Returns:

Whether the provided node may be used with this entry data to obtain a value.