com.github.stefvanschie.inventoryframework

Class HumanEntityCache

java.lang.Object

com.github.stefvanschie.inventoryframework.HumanEntityCache

public class HumanEntityCache
extends Object

A class for containing players and their inventory state for later use

Since:

0.4.0

Constructor Summary

Constructors

Constructor and Description
HumanEntityCache()

Method Summary

Modifier and Type	Method and Description
void	clearCache() Deprecated. use restoreAndForgetAll() instead
void	clearCache(@NotNull org.bukkit.entity.HumanEntity humanEntity) Deprecated. use restoreAndForget(HumanEntity) instead
void	restore(@NotNull org.bukkit.entity.HumanEntity humanEntity) Deprecated. use restoreAndForget(HumanEntity) instead
void	restoreAll() Deprecated. use restoreAndForgetAll() instead
void	restoreAndForget(@NotNull org.bukkit.entity.HumanEntity humanEntity) Restores the contents of the specified human entity, clearing the cache afterwards.
void	restoreAndForgetAll() Restores all players' contents into their inventory, clearing the cache afterwards.
void	store(@NotNull org.bukkit.entity.HumanEntity humanEntity) Deprecated. use storeAndClear(HumanEntity) instead
void	storeAndClear(@NotNull org.bukkit.entity.HumanEntity humanEntity) Stores this player's inventory in the cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

HumanEntityCache

public HumanEntityCache()

Method Detail

storeAndClear

public void storeAndClear(@NotNull
                          @NotNull org.bukkit.entity.HumanEntity humanEntity)

Stores this player's inventory in the cache. If the player was already stored, their cache will be overwritten. Clears the player's inventory afterwards.

Parameters:

humanEntity - the human entity to keep in the cache

store

@Deprecated
public void store(@NotNull
                               @NotNull org.bukkit.entity.HumanEntity humanEntity)

Deprecated. use storeAndClear(HumanEntity) instead

Stores this player's inventory in the cache. If the player was already stored, their cache will be overwritten.

Parameters:

humanEntity - the human entity to keep in the cache

Since:

0.4.0

restoreAndForget

public void restoreAndForget(@NotNull
                             @NotNull org.bukkit.entity.HumanEntity humanEntity)

Restores the contents of the specified human entity, clearing the cache afterwards. This method will fail silently if no cache is available.

Parameters:

humanEntity - the human entity to restore its cache for

Since:

0.5.19

restoreAndForgetAll

public void restoreAndForgetAll()

Restores all players' contents into their inventory, clearing the cache afterwards.

Since:

0.5.19

restore

@Deprecated
public void restore(@NotNull
                                 @NotNull org.bukkit.entity.HumanEntity humanEntity)

Deprecated. use restoreAndForget(HumanEntity) instead

Restores the contents of the specified human entity. This method will fail silently if no cache is available. The cache will not be cleared.

Parameters:

humanEntity - the human entity to restore its cache for

Since:

0.4.0

restoreAll

@Deprecated
public void restoreAll()

Deprecated. use restoreAndForgetAll() instead

Restores all players' contents into their inventory. The cache will not be cleared.

Since:

0.4.0

clearCache

@Deprecated
public void clearCache(@NotNull
                                    @NotNull org.bukkit.entity.HumanEntity humanEntity)

Deprecated. use restoreAndForget(HumanEntity) instead

Clear the cache for the specified human entity

Parameters:

humanEntity - the human entity to clear the cache for

Since:

0.4.0

clearCache

@Deprecated
public void clearCache()

Deprecated. use restoreAndForgetAll() instead

This clears the cache.

Since:

0.4.0