me.piggypiglet.framework.managers

Class Manager<S>

java.lang.Object

me.piggypiglet.framework.managers.Manager<S>

Direct Known Subclasses:

DefaultPermissionStore, InventoryManager, PlayerInventoryManager, SearchableManager

public abstract class Manager<S>
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected KeyTypeInfo	keyTypes

Constructor Summary

Constructors

Constructor and Description
Manager()

Method Summary

Modifier and Type	Method and Description
void	add(S item) Store an item to this manager
protected abstract KeyTypeInfo	configure(KeyTypeInfo.Builder builder) Configure acceptable key types
protected abstract void	delete(S item) Handle deleting an item from underlying data structures
<T,U> boolean	exists(T key) Check if a key is set based on configured key types.
<T,U> S	get(T key) Get a value based on configured key types
java.util.Collection<S>	getAll() Get everything stored in this manager.
protected abstract void	insert(S item) Handle inserting an item into underlying data structures
protected void	postConfigure() Ran after Manager#configure
protected void	preConfigure() Ran before Manager#configure
void	remove(S item) Remove an item from this manager
protected abstract java.util.Collection<S>	retrieveAll() Retrieve values from any data structures in this manager
void	setup() Populate the manager.

Methods inherited from class java.lang.Object

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

Field Detail

keyTypes

protected KeyTypeInfo keyTypes

Constructor Detail

Manager

public Manager()

Method Detail

configure

protected abstract KeyTypeInfo configure(KeyTypeInfo.Builder builder)

Configure acceptable key types

Parameters:

builder - Instance of KeyTypeInfo builder

Returns:

Built KeyTypeInfo

preConfigure

protected void preConfigure()

Ran before Manager#configure

postConfigure

protected void postConfigure()

Ran after Manager#configure

setup

public void setup()

Populate the manager.

insert

protected abstract void insert(S item)

Handle inserting an item into underlying data structures

Parameters:

item - Item to insert

delete

protected abstract void delete(S item)

Handle deleting an item from underlying data structures

Parameters:

item - Item to delete

retrieveAll

protected abstract java.util.Collection<S> retrieveAll()

Retrieve values from any data structures in this manager

Returns:

Collection of values

add

public void add(S item)

Store an item to this manager

Parameters:

item - Item

remove

public void remove(S item)

Remove an item from this manager

Parameters:

item - Item

getAll

public java.util.Collection<S> getAll()

Get everything stored in this manager.

Returns:

Collection of values

get

public <T,U> S get(T key)

Get a value based on configured key types

Type Parameters:

T - Key type

U - Raw type before mapping

Parameters:

key - Key value

Returns:

Value

exists

public <T,U> boolean exists(T key)

Check if a key is set based on configured key types.

Type Parameters:

T - Key type

U - Raw type before mapping

Parameters:

key - Key value

Returns:

boolean of whether it exists or not in the underlying data structure(s)