Package me.hsgamer.timedtopper.api

Interface TimedTopperAPI

public interface TimedTopperAPI

The API of TimedTopper

Field Summary

Fields

Modifier and Type	Field	Description
static final AtomicReference<TimedTopperAPI>	INSTANCE	The reference of the instance of the API

Method Summary

Modifier and Type	Method	Description
Map<UUID,TimedData>	getData(String holder)	Get the data of the holder
Optional<TimedData>	getData(String holder, UUID uuid)	Get the data of a unique id in the holder
Collection<String>	getHolders()	Get the name of the available holders
static TimedTopperAPI	getInstance()	Get the instance of the API
TimeRange	getTimeRange(String holder)	Get the time range of the holder
boolean	hasHolder(String holder)	Check if the holder exists

Field Details

INSTANCE

static final AtomicReference<TimedTopperAPI> INSTANCE

The reference of the instance of the API

Method Details

getInstance

static TimedTopperAPI getInstance()

Get the instance of the API

Returns:

the instance of the API

getHolders

Collection<String> getHolders()

Get the name of the available holders

Returns:

the holder names

hasHolder

boolean hasHolder(String holder)

Check if the holder exists

Parameters:

holder - the holder

Returns:

true if it does

getData

Map<UUID,TimedData> getData(String holder)

Get the data of the holder

Parameters:

holder - the holder

Returns:

the data

getData

Optional<TimedData> getData(String holder,
 UUID uuid)

Get the data of a unique id in the holder

Parameters:

holder - the holder

uuid - the unique id

Returns:

the data, or empty if the id doesn't exist

Throws:

NullPointerException - if the holder doesn't exist

getTimeRange

TimeRange getTimeRange(String holder)

Get the time range of the holder

Parameters:

holder - the holder

Returns:

the time range

Throws:

NullPointerException - if the holder doesn't exist