io.papermc.paper.tag

Class BaseTag<T extends Keyed,C extends BaseTag<T,C>>

java.lang.Object

io.papermc.paper.tag.BaseTag<T,C>

All Implemented Interfaces:

Keyed, Tag<T>

Direct Known Subclasses:

EntitySetTag, MaterialSetTag

public abstract class BaseTag<T extends Keyed,C extends BaseTag<T,C>>
extends Object
implements Tag<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected NamespacedKey	key
protected Set<T>	tagged

Fields inherited from interface org.bukkit.Tag

ACACIA_LOGS, ANVIL, ARROWS, BAMBOO_PLANTABLE_ON, BANNERS, BEACON_BASE_BLOCKS, BEDS, BEE_GROWABLES, BEEHIVE_INHABITORS, BEEHIVES, BIRCH_LOGS, BUTTONS, CAMPFIRES, CARPETS, CLIMBABLE, CORAL_BLOCKS, CORAL_PLANTS, CORALS, CRIMSON_STEMS, CROPS, DARK_OAK_LOGS, DOORS, DRAGON_IMMUNE, ENDERMAN_HOLDABLE, FENCE_GATES, FENCES, FIRE, FLOWER_POTS, FLOWERS, FLUIDS_LAVA, FLUIDS_WATER, GOLD_ORES, GUARDED_BY_PIGLINS, HOGLIN_REPELLENTS, ICE, IMPACT_PROJECTILES, IMPERMEABLE, INFINIBURN_END, INFINIBURN_NETHER, INFINIBURN_OVERWORLD, ITEMS_ARROWS, ITEMS_BANNERS, ITEMS_BEACON_PAYMENT_ITEMS, ITEMS_BOATS, ITEMS_COALS, ITEMS_CREEPER_DROP_MUSIC_DISCS, ITEMS_FISHES, ITEMS_FURNACE_MATERIALS, ITEMS_LECTERN_BOOKS, ITEMS_MUSIC_DISCS, ITEMS_PIGLIN_LOVED, ITEMS_STONE_TOOL_MATERIALS, JUNGLE_LOGS, LEAVES, LOGS, LOGS_THAT_BURN, NON_FLAMMABLE_WOOD, NYLIUM, OAK_LOGS, PIGLIN_REPELLENTS, PLANKS, PORTALS, PRESSURE_PLATES, PREVENT_MOB_SPAWNING_INSIDE, RAIDERS, RAILS, REGISTRY_BLOCKS, REGISTRY_ENTITIES, REGISTRY_FLUIDS, REGISTRY_ITEMS, SAND, SAPLINGS, SHULKER_BOXES, SIGNS, SKELETONS, SLABS, SMALL_FLOWERS, SOUL_FIRE_BASE_BLOCKS, SOUL_SPEED_BLOCKS, SPRUCE_LOGS, STAIRS, STANDING_SIGNS, STONE_BRICKS, STONE_PRESSURE_PLATES, STRIDER_WARM_BLOCKS, TALL_FLOWERS, TRAPDOORS, UNDERWATER_BONEMEALS, UNSTABLE_BOTTOM_CENTER, VALID_SPAWN, WALL_CORALS, WALL_POST_OVERRIDE, WALL_SIGNS, WALLS, WARPED_STEMS, WART_BLOCKS, WITHER_IMMUNE, WITHER_SUMMON_BASE_BLOCKS, WOODEN_BUTTONS, WOODEN_DOORS, WOODEN_FENCES, WOODEN_PRESSURE_PLATES, WOODEN_SLABS, WOODEN_STAIRS, WOODEN_TRAPDOORS, WOOL

Constructor Summary

Constructors

Constructor and Description
BaseTag(@NotNull Class<T> clazz, @NotNull NamespacedKey key, @NotNull Collection<T> values)
BaseTag(@NotNull Class<T> clazz, @NotNull NamespacedKey key, @NotNull Collection<T> values, Predicate<T>... globalPredicates)
BaseTag(@NotNull Class<T> clazz, @NotNull NamespacedKey key, @NotNull Predicate<T> filter)
BaseTag(@NotNull Class<T> clazz, @NotNull NamespacedKey key, T... values)

Method Summary

Modifier and Type	Method and Description
C	add(@NotNull Collection<T> collection)
C	add(@NotNull Predicate<T> filter)
C	add(T... values)
C	add(Tag<T>... tags)
C	contains(@NotNull String with)
C	endsWith(@NotNull String with)
C	ensureSize(@NotNull String label, int size)
protected abstract @NotNull Set<T>	getAllPossibleValues()
@NotNull NamespacedKey	getKey() Return the namespaced identifier for this object.
protected abstract @NotNull String	getName(T value)
@NotNull Set<T>	getValues() Gets an immutable set of all tagged items.
boolean	isTagged(T item) Returns whether or not this tag has an entry for the specified item.
C	not(@NotNull Collection<T> values)
C	not(@NotNull Predicate<T> filter)
C	not(T... values)
C	not(Tag<T>... tags)
C	notContains(@NotNull String with)
C	notEndsWith(@NotNull String with)
C	notStartsWith(@NotNull String with)
C	startsWith(@NotNull String with)

Methods inherited from class java.lang.Object

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

Field Detail

key

protected final NamespacedKey key

tagged

protected final Set<T extends Keyed> tagged

Constructor Detail

BaseTag

public BaseTag(@NotNull
               @NotNull Class<T> clazz,
               @NotNull
               @NotNull NamespacedKey key,
               @NotNull
               @NotNull Predicate<T> filter)

BaseTag

public BaseTag(@NotNull
               @NotNull Class<T> clazz,
               @NotNull
               @NotNull NamespacedKey key,
               @NotNull
               T... values)

BaseTag

public BaseTag(@NotNull
               @NotNull Class<T> clazz,
               @NotNull
               @NotNull NamespacedKey key,
               @NotNull
               @NotNull Collection<T> values)

BaseTag

public BaseTag(@NotNull
               @NotNull Class<T> clazz,
               @NotNull
               @NotNull NamespacedKey key,
               @NotNull
               @NotNull Collection<T> values,
               @NotNull
               Predicate<T>... globalPredicates)

Method Detail

getKey

@NotNull
public @NotNull NamespacedKey getKey()

Description copied from interface: Keyed

Return the namespaced identifier for this object.

Specified by:

getKey in interface Keyed

Returns:

this object's key

getValues

@NotNull
public @NotNull Set<T> getValues()

Description copied from interface: Tag

Gets an immutable set of all tagged items.

Specified by:

getValues in interface Tag<T extends Keyed>

Returns:

set of tagged items

isTagged

public boolean isTagged(@NotNull
                        T item)

Description copied from interface: Tag

Returns whether or not this tag has an entry for the specified item.

Specified by:

isTagged in interface Tag<T extends Keyed>

Parameters:

item - to check

Returns:

if it is tagged

add

@NotNull
public C add(@NotNull
                      Tag<T>... tags)

add

@NotNull
public C add(@NotNull
                      T... values)

add

@NotNull
public C add(@NotNull
                      @NotNull Collection<T> collection)

add

@NotNull
public C add(@NotNull
                      @NotNull Predicate<T> filter)

contains

@NotNull
public C contains(@NotNull
                           @NotNull String with)

endsWith

@NotNull
public C endsWith(@NotNull
                           @NotNull String with)

startsWith

@NotNull
public C startsWith(@NotNull
                             @NotNull String with)

not

@NotNull
public C not(@NotNull
                      Tag<T>... tags)

not

@NotNull
public C not(@NotNull
                      T... values)

not

@NotNull
public C not(@NotNull
                      @NotNull Collection<T> values)

not

@NotNull
public C not(@NotNull
                      @NotNull Predicate<T> filter)

notContains

@NotNull
public C notContains(@NotNull
                              @NotNull String with)

notEndsWith

@NotNull
public C notEndsWith(@NotNull
                              @NotNull String with)

notStartsWith

@NotNull
public C notStartsWith(@NotNull
                                @NotNull String with)

ensureSize

@NotNull
public C ensureSize(@NotNull
                             @NotNull String label,
                             int size)

getAllPossibleValues

@NotNull
protected abstract @NotNull Set<T> getAllPossibleValues()

getName

@NotNull
protected abstract @NotNull String getName(@NotNull
                                                    T value)