Package io.github.projectunified.valuevenue.core

Class EnumValueGenerator<K,SV extends Enum<SV>,FV>

java.lang.Object

io.github.projectunified.valuevenue.core.CachedValueGenerator<K,SV,FV>

io.github.projectunified.valuevenue.core.EnumValueGenerator<K,SV,FV>

Type Parameters:

K - type of the key used to select values

SV - enum type of the source value

FV - type of the final value

All Implemented Interfaces:

Function<K,List<FV>>

public abstract class EnumValueGenerator<K,SV extends Enum<SV>,FV>
extends CachedValueGenerator<K,SV,FV>

A CachedValueGenerator whose source values are all constants of an enum.

Constructor Summary

Constructors

Constructor	Description
EnumValueGenerator()

Method Summary

Modifier and Type	Method	Description
abstract Class<SV>	getEnumType()	Enum whose constants are the source values.
Stream<SV>	getSourceValueStream()	All source values the generator knows without a key, so CachedValueGenerator.update() can create their cache entries upfront.

Methods inherited from class io.github.projectunified.valuevenue.core.CachedValueGenerator

apply, getCachedValues, getSourceValueStream, isSourceValueActivated, isValueActivated, mapToFinalValue, update

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

andThen, compose

Constructor Details

EnumValueGenerator

public EnumValueGenerator()

Method Details

getEnumType

public abstract Class<SV> getEnumType()

Enum whose constants are the source values. CachedValueGenerator.update() creates the cache entries of all of them upfront. Must return the same type on every call; it is read once to cache the constants.

Returns:

enum type of the source values

getSourceValueStream

public Stream<SV> getSourceValueStream()

Description copied from class: CachedValueGenerator

All source values the generator knows without a key, so CachedValueGenerator.update() can create their cache entries upfront. Empty by default: a key-only generator needs no override, while its entries are created lazily by CachedValueGenerator.apply(Object). Values that can only be reached through a key are returned by CachedValueGenerator.getSourceValueStream(Object) instead.

Overrides:

getSourceValueStream in class CachedValueGenerator<K,SV extends Enum<SV>,FV>

Returns:

stream of every key-independent source value