Package me.croabeast.file

Interface UnitMappable<U extends ConfigurableUnit,C extends Collection<U>,UM extends UnitMappable<U,C,UM>>

Type Parameters:

U - The type of configurable unit stored.

C - The type of collection that holds the configurable units.

UM - The type of the implementing UnitMappable instance.

All Superinterfaces:

BaseBuilder<UM>, Copyable<UM>, Iterable<Map.Entry<Integer,C>>, Map<Integer,C>, Mappable<U,C,UM>

All Known Subinterfaces:

UnitMappable.List<U>, UnitMappable.Set<U>

public interface UnitMappable<U extends ConfigurableUnit,C extends Collection<U>,UM extends UnitMappable<U,C,UM>>
extends Mappable<U,C,UM>

Represents a mappable collection of configurable units.

UnitMappable extends Mappable to provide a specialized mapping where integer keys are associated with collections of ConfigurableUnit objects. It adds factory methods for creating new instances with specific backing collection types and supports operations such as merging values from multiple keys.

Important: For full functionality, you must implement the base UnitMappable interface. However, its nested sub-interfaces UnitMappable.Set and UnitMappable.List are designed to be directly instantiated using the provided static factory methods asSet(Map) and asList(Map), which return ready-to-use implementations.

See Also:

• Mappable

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	UnitMappable.List<U extends ConfigurableUnit>	A sub-interface of UnitMappable specialized for list-backed collections.
static interface	UnitMappable.Set<U extends ConfigurableUnit>	A sub-interface of UnitMappable specialized for set-backed collections.

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Nested classes/interfaces inherited from interface me.croabeast.file.Mappable

Mappable.BaseList<T,B extends Mappable.BaseList<T,B>>, Mappable.BaseSet<T,B extends Mappable.BaseSet<T,B>>

Method Summary

Modifier and Type	Method	Description
static <U extends ConfigurableUnit> UnitMappable.List<U>	asList()	Creates an empty UnitMappable.List instance.
static <U extends ConfigurableUnit> UnitMappable.List<U>	asList(Map<Integer,List<U>> map)	Creates a new UnitMappable.List instance from the given map.
static <U extends ConfigurableUnit> UnitMappable.Set<U>	asSet()	Creates an empty UnitMappable.Set instance.
static <U extends ConfigurableUnit> UnitMappable.Set<U>	asSet(Map<Integer,Set<U>> map)	Creates a new UnitMappable.Set instance from the given map.
default U	getUnit(@Nullable org.bukkit.entity.Player player)

Methods inherited from interface me.croabeast.common.builder.BaseBuilder

instance

Methods inherited from interface me.croabeast.common.Copyable

copy

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from interface me.croabeast.file.Mappable

filter, getStoredValues, getStoredValues, iterator, order, order

Method Details

getUnit

@Nullable
default U getUnit(@Nullable
 @Nullable org.bukkit.entity.Player player)

asSet

static <U extends ConfigurableUnit>
UnitMappable.Set<U> asSet(Map<Integer,Set<U>> map)

Creates a new UnitMappable.Set instance from the given map.

Type Parameters:

U - the type of configurable unit.

Parameters:

map - the map containing integer keys mapping to sets of ConfigurableUnit objects.

Returns:

a new UnitMappable.Set instance populated with the provided map.

asSet

static <U extends ConfigurableUnit>
UnitMappable.Set<U> asSet()

Creates an empty UnitMappable.Set instance.

Type Parameters:

U - the type of configurable unit.

Returns:

a new empty UnitMappable.Set instance.

asList

static <U extends ConfigurableUnit>
UnitMappable.List<U> asList(Map<Integer,List<U>> map)

Creates a new UnitMappable.List instance from the given map.

Type Parameters:

U - the type of configurable unit.

Parameters:

map - the map containing integer keys mapping to lists of ConfigurableUnit objects.

Returns:

a new UnitMappable.List instance populated with the provided map.

asList

static <U extends ConfigurableUnit>
UnitMappable.List<U> asList()

Creates an empty UnitMappable.List instance.

Type Parameters:

U - the type of configurable unit.

Returns:

a new empty UnitMappable.List instance.