Package de.murmelmeister.murmelapi.group

Interface GroupProvider

public sealed interface GroupProvider

Represents a group in the MurmelAPI.

This interface is used to define a group that can be managed by the MurmelAPI. It is a marker interface and does not contain any methods.

The GroupProviderImpl interface extends this interface to provide additional functionality.

Method Summary

Modifier and Type	Method	Description
@NotNull Optional<Group>	create(@NotNull String groupName, int priority, int createdBy)
int	delete(int groupId)
@NotNull @Unmodifiable List<Group>	findAll()
@NotNull @Unmodifiable List<String>	findAllGroupNames()
@NotNull Optional<Group>	findById(int id)
@NotNull Optional<Group>	findByName(@NotNull String groupName)
static @NotNull GroupProvider	of(de.murmelmeister.library.database.Database database, com.google.gson.Gson gson, RefreshProvider refreshProvider, Long fetchLimit, long cacheCapacity, Duration refreshInterval)
void	refreshCache()
@NotNull Optional<Group>	update(int groupId, @NotNull String groupName, int priority, int changedBy)

Method Details

refreshCache

void refreshCache()

findById

@NotNull
@NotNull Optional<Group> findById(int id)

findByName

@NotNull
@NotNull Optional<Group> findByName(@NotNull
 @NotNull String groupName)

findAll

@NotNull
@NotNull @Unmodifiable List<Group> findAll()

findAllGroupNames

@NotNull
@NotNull @Unmodifiable List<String> findAllGroupNames()

create

@NotNull
@NotNull Optional<Group> create(@NotNull
 @NotNull String groupName,
 int priority,
 int createdBy)

delete

int delete(int groupId)

update

@NotNull
@NotNull Optional<Group> update(int groupId,
 @NotNull
 @NotNull String groupName,
 int priority,
 int changedBy)

of

@Internal
@NotNull
static @NotNull GroupProvider of(de.murmelmeister.library.database.Database database,
 com.google.gson.Gson gson,
 RefreshProvider refreshProvider,
 Long fetchLimit,
 long cacheCapacity,
 Duration refreshInterval)