Class EntityData.EntityDataPatterns<Data>

java.lang.Object

org.skriptlang.skript.bukkit.entity.EntityData.EntityDataPatterns<Data>

Type Parameters:

Data - The type of object representing the state(s) of the entities in the EntityData.PatternGroups.

Enclosing class:

EntityData<E extends org.bukkit.entity.Entity>

public static class EntityData.EntityDataPatterns<Data>
extends Object

Collection of EntityData.PatternGroups to be parsed and retrieved.

Constructor Summary

Constructors

Constructor	Description
EntityDataPatterns(EntityData.PatternGroup<Data>... patternGroups)

Method Summary

Modifier and Type	Method	Description
Data	getData(int index)	Gets the data of the EntityData.PatternGroup at the index.
protected Map<Data, EntityData.PatternGroup<Data>>	getDataMap()	Gets the Map that correlates Data to a EntityData.PatternGroup.
EntityData.PatternGroup<Data>	getGenericGroup()	Gets the generic group.
protected Map<Integer, EntityData.PatternGroup<Data>>	getGroupMap()	Gets the Map that correlates index to a EntityData.PatternGroup.
int	getIndex(Data data)	Gets the index that the EntityData.PatternGroup with data.
GeneralNoun	getName(int index)	Gets the GeneralNoun of the EntityData.PatternGroup at the index.
GeneralNoun	getName(Data data)	Gets the GeneralNoun of the EntityData.PatternGroup with data.
SequencedCollection<GeneralNoun>	getNames()	Gets the GeneralNouns from all the EntityData.PatternGroups.
EntityData.PatternGroup<Data>	getPatternGroup(int index)	Gets the EntityData.PatternGroup correlating to index.
EntityData.PatternGroup<Data>	getPatternGroup(Data data)	Gets the EntityData.PatternGroup correlating to data.
SequencedCollection<EntityData.PatternGroup<Data>>	getPatternGroups()	Gets the EntityData.PatternGroups provided when constructed.
static <Data> EntityData.EntityDataPatterns<Data>	single(String name, Data data, String... patterns)	Create a simple EntityData.EntityDataPatterns with only one EntityData.PatternGroup from the provided parameters.
static EntityData.EntityDataPatterns<?>	single(String name, String... patterns)	Create a simple EntityData.EntityDataPatterns with only one EntityData.PatternGroup from the provided parameters.

Methods inherited from class Object

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

Constructor Details

EntityDataPatterns

@SafeVarargs
public EntityDataPatterns(EntityData.PatternGroup<Data>... patternGroups)

Method Details

single

public static EntityData.EntityDataPatterns<?> single(String name,
 String... patterns)

Create a simple EntityData.EntityDataPatterns with only one EntityData.PatternGroup from the provided parameters.

Parameters:

name - The name of the entity.

patterns - The patterns that refer to the entity.

Returns:

The constructed EntityData.EntityDataPatterns.

single

public static <Data>
EntityData.EntityDataPatterns<Data> single(String name,
 @Nullable
 Data data,
 String... patterns)

Create a simple EntityData.EntityDataPatterns with only one EntityData.PatternGroup from the provided parameters.

Type Parameters:

Data - The type of data correlating to the entity.

Parameters:

name - The name of the entity.

data - The data correlating to the entity.

patterns - The patterns that refer to the entity.

Returns:

The constructed EntityData.EntityDataPatterns.

getGenericGroup

public EntityData.PatternGroup<Data> getGenericGroup()

Gets the generic group. A group is considered generic when it does not correlate to any Data.

Returns:

The generic group.

getNames

public SequencedCollection<GeneralNoun> getNames()

Gets the GeneralNouns from all the EntityData.PatternGroups.

Returns:

The GeneralNouns.

getPatternGroups

public SequencedCollection<EntityData.PatternGroup<Data>> getPatternGroups()

Gets the EntityData.PatternGroups provided when constructed.

Returns:

The EntityData.PatternGroups.

getGroupMap

protected Map<Integer, EntityData.PatternGroup<Data>> getGroupMap()

Gets the Map that correlates index to a EntityData.PatternGroup.

Returns:

The Map.

getDataMap

protected Map<Data, EntityData.PatternGroup<Data>> getDataMap()

Gets the Map that correlates Data to a EntityData.PatternGroup.

Returns:

The Map.

getPatternGroup

public EntityData.PatternGroup<Data> getPatternGroup(int index)

Gets the EntityData.PatternGroup correlating to index.

Parameters:

index - The index of the EntityData.PatternGroup to grab.

Returns:

The EntityData.PatternGroup if found, otherwise the generic group.

getPatternGroup

public EntityData.PatternGroup<Data> getPatternGroup(@Nullable
 Data data)

Gets the EntityData.PatternGroup correlating to data.

Parameters:

data - The data of the EntityData.PatternGroup to grab.

Returns:

The EntityData.PatternGroup if found, otherwise the generic group.

getIndex

public int getIndex(@Nullable
 Data data)

Gets the index that the EntityData.PatternGroup with data.

Parameters:

data - The data of the EntityData.PatternGroup to grab the index from.

Returns:

The index.

getData

@Nullable
public Data getData(int index)

Gets the data of the EntityData.PatternGroup at the index.

Parameters:

index - The index of the EntityData.PatternGroup to grab the data from.

Returns:

The data.

getName

public GeneralNoun getName(int index)

Gets the GeneralNoun of the EntityData.PatternGroup at the index.

Parameters:

index - The index of EntityData.PatternGroup to grab the GeneralNoun from.

Returns:

The GeneralNoun.

getName

public GeneralNoun getName(@Nullable
 Data data)

Gets the GeneralNoun of the EntityData.PatternGroup with data.

Parameters:

data - The data of the EntityData.PatternGroup to grab the GeneralNoun from.

Returns:

The GeneralNoun.