Package com.minecolonies.core.colony.requestsystem.management.manager

Class StandardRequestManager

java.lang.Object

com.minecolonies.core.colony.requestsystem.management.manager.StandardRequestManager

All Implemented Interfaces:

IRequestManager, ITickable, IStandardRequestManager, net.minecraftforge.common.util.INBTSerializable<net.minecraft.nbt.CompoundTag>

public class StandardRequestManager
extends Object
implements IStandardRequestManager

Main class of the request system. Default implementation of the IRequestManager interface.

Uses

Constructor Summary

Constructors

Constructor	Description
StandardRequestManager(@NotNull IColony colony)

Method Summary

Modifier and Type	Method	Description
void	assignRequest(@NotNull IToken<?> token)	Method used to assign a request to a resolver.
<T extends IRequestable> @NotNull IToken<?>	createAndAssignRequest(@NotNull IRequester requester, T object)	Method used to create and immediately assign a request.
<T extends IRequestable> @NotNull IToken<?>	createRequest(@NotNull IRequester requester, T object)	Method to create a request for a given object
void	deserialize(IFactoryController controller, net.minecraft.network.FriendlyByteBuf buffer)	deserialize this request manager from the give FriendlyByteBuf
void	deserializeNBT(net.minecraft.nbt.CompoundTag nbt)	Method used to deserialize the data inside the given nbt tag into this request system.
@NotNull IColony	getColony()	The colony this manager manages the requests for.
int	getCurrentVersion()
@NotNull IDataStoreManager	getDataStoreManager()	Get the data store manager.
@NotNull IFactoryController	getFactoryController()	Method used to get the FactoryController of the RequestManager.
@NotNull IPlayerRequestResolver	getPlayerResolver()	Get the player resolve.
IProviderHandler	getProviderHandler()
@NotNull IProviderResolverAssignmentDataStore	getProviderResolverAssignmentDataStore()
@NotNull IRequestableTypeRequestResolverAssignmentDataStore	getRequestableTypeRequestResolverAssignmentDataStore()
@Nullable IRequest<?>	getRequestForToken(@NotNull IToken<?> token)	Method to get a request for a given token.
IRequestHandler	getRequestHandler()
@NotNull IRequestIdentitiesDataStore	getRequestIdentitiesDataStore()
@NotNull IRequestResolverIdentitiesDataStore	getRequestResolverIdentitiesDataStore()
@NotNull IRequestResolverRequestAssignmentDataStore	getRequestResolverRequestAssignmentDataStore()
@Nullable IRequestResolver<?>	getResolverForRequest(@NotNull IToken<?> requestToken)	Method to get a resolver for a given request.
@NotNull IRequestResolver<?>	getResolverForToken(@NotNull IToken<?> token)	Method to get a resolver from its token.
IResolverHandler	getResolverHandler()
@NotNull IRetryingRequestResolver	getRetryingRequestResolver()	Get the retrying request resolver.
ITokenHandler	getTokenHandler()
IUpdateHandler	getUpdateHandler()
boolean	isDirty()	Check if the request manager is dirty.
void	log(String message)	Log a debug message.
void	markDirty()	Mark the request manager and colony as dirty.
void	onColonyUpdate(@NotNull Predicate<IRequest<?>> shouldTriggerReassign)	Method used to reassign requests based on a predicate.
void	onProviderAddedToColony(@NotNull IRequestResolverProvider provider)	Method used to indicate to this manager that a new Provider has been added to the colony.
void	onProviderRemovedFromColony(@NotNull IRequestResolverProvider provider)	Method used to indicate to this manager that Provider has been removed from the colony.
void	onRequesterRemovedFromColony(@NotNull IRequester requester)	Method used to indicate to this manager that a Requster has been removed from the colony.
void	overruleRequest(@NotNull IToken<?> token, @Nullable net.minecraft.world.item.ItemStack stack)	Method used to overrule a request.
@Nullable IToken<?>	reassignRequest(@NotNull IToken<?> token, @NotNull Collection<IToken<?>> resolverTokenBlackList)	Method used to reassign a given request.
void	reset()	Called to reset the RS.
void	serialize(IFactoryController controller, net.minecraft.network.FriendlyByteBuf buffer)	serialize this request manager to the give FriendlyByteBuf
net.minecraft.nbt.CompoundTag	serializeNBT()	Method used to serialize the current request system to NBT.
void	setCurrentVersion(int currentVersion)
void	setDirty(boolean isDirty)	Sets if dirty and needs to be updated.
void	tick()	Default parameterless ticking implementation.
void	updateRequestState(@NotNull IToken<?> token, @NotNull RequestState state)	Method to update the state of a given request.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.minecolonies.api.tileentities.ITickable

tick

Constructor Details

StandardRequestManager

public StandardRequestManager(@NotNull
 @NotNull IColony colony)

Method Details

getColony

@NotNull
public @NotNull IColony getColony()

The colony this manager manages the requests for.

Specified by:

getColony in interface IRequestManager

Returns:

The colony this manager manages the requests for.

getFactoryController

@NotNull
public @NotNull IFactoryController getFactoryController()

Method used to get the FactoryController of the RequestManager.

Specified by:

getFactoryController in interface IRequestManager

Returns:

The FactoryController of this RequestManager.

createRequest

@NotNull
public <T extends IRequestable> @NotNull IToken<?> createRequest(@NotNull
 @NotNull IRequester requester,
 @NotNull
 T object)

Method to create a request for a given object

Specified by:

createRequest in interface IRequestManager

Type Parameters:

T - The type of request.

Parameters:

requester - The requester.

object - The Object that is being requested.

Returns:

The token representing the request.

Throws:

IllegalArgumentException - is thrown when this manager cannot produce a request for the given types.

markDirty

public void markDirty()

Mark the request manager and colony as dirty.

Specified by:

markDirty in interface IRequestManager

isDirty

public boolean isDirty()

Check if the request manager is dirty.

Specified by:

isDirty in interface IRequestManager

Returns:

true if so.

setDirty

public void setDirty(boolean isDirty)

Description copied from interface: IRequestManager

Sets if dirty and needs to be updated.

Specified by:

setDirty in interface IRequestManager

Parameters:

isDirty - true if so.

assignRequest

public void assignRequest(@NotNull
 @NotNull IToken<?> token)

Method used to assign a request to a resolver.

Specified by:

assignRequest in interface IRequestManager

Parameters:

token - The token of the request to assign.

Throws:

IllegalArgumentException - when the token is not registered to a request, or is already assigned to a resolver.

createAndAssignRequest

@NotNull
public <T extends IRequestable> @NotNull IToken<?> createAndAssignRequest(@NotNull
 @NotNull IRequester requester,
 @NotNull
 T object)

Method used to create and immediately assign a request.

Specified by:

createAndAssignRequest in interface IRequestManager

Type Parameters:

T - The type of the requestable

Parameters:

requester - The requester of the requestable.

object - The requestable

Returns:

The token that represents the request.

Throws:

IllegalArgumentException - when either createRequest or assignRequest have thrown an IllegalArgumentException

reassignRequest

@Nullable
public @Nullable IToken<?> reassignRequest(@NotNull
 @NotNull IToken<?> token,
 @NotNull
 @NotNull Collection<IToken<?>> resolverTokenBlackList)

Description copied from interface: IRequestManager

Method used to reassign a given request.

Specified by:

reassignRequest in interface IRequestManager

Parameters:

token - The token of the request that should be reassigned.

resolverTokenBlackList - the blacklist.

Returns:

The token of the resolver that has gotten the assignment, null if none was found.

getRequestForToken

@Nullable
public @Nullable IRequest<?> getRequestForToken(@NotNull
 @NotNull IToken<?> token)
                                         throws IllegalArgumentException

Description copied from interface: IRequestManager

Method to get a request for a given token.

Specified by:

getRequestForToken in interface IRequestManager

Parameters:

token - The token to get a request for.

Returns:

The request of the given type for that token.

Throws:

IllegalArgumentException - when the token does not produce a request of the given type T.

getResolverForToken

@NotNull
public @NotNull IRequestResolver<?> getResolverForToken(@NotNull
 @NotNull IToken<?> token)
                                                 throws IllegalArgumentException

Description copied from interface: IRequestManager

Method to get a resolver from its token.

Specified by:

getResolverForToken in interface IRequestManager

Parameters:

token - the token.

Returns:

The resolver registered with the given token.

Throws:

IllegalArgumentException - when the token is unknown.

getResolverForRequest

@Nullable
public @Nullable IRequestResolver<?> getResolverForRequest(@NotNull
 @NotNull IToken<?> requestToken)
                                                    throws IllegalArgumentException

Description copied from interface: IRequestManager

Method to get a resolver for a given request.

Specified by:

getResolverForRequest in interface IRequestManager

Parameters:

requestToken - The token of the request to get resolver for.

Returns:

Null if the request is not yet resolved, or else the assigned resolver.

Throws:

IllegalArgumentException - Thrown when the token is unknown.

updateRequestState

public void updateRequestState(@NotNull
 @NotNull IToken<?> token,
 @NotNull
 @NotNull RequestState state)

Method to update the state of a given request.

Specified by:

updateRequestState in interface IRequestManager

Parameters:

token - The token that represents a given request to update.

state - The new state of that request.

Throws:

IllegalArgumentException - when the token is unknown to this manager.

onProviderAddedToColony

public void onProviderAddedToColony(@NotNull
 @NotNull IRequestResolverProvider provider)

Method used to indicate to this manager that a new Provider has been added to the colony.

Specified by:

onProviderAddedToColony in interface IRequestManager

Parameters:

provider - The new provider.

overruleRequest

public void overruleRequest(@NotNull
 @NotNull IToken<?> token,
 @Nullable
 @Nullable net.minecraft.world.item.ItemStack stack)

Description copied from interface: IRequestManager

Method used to overrule a request. Updates the state and sets the delivery if applicable.

Specified by:

overruleRequest in interface IRequestManager

Parameters:

token - The token of the request that is being overruled.

stack - The stack that should be treated as delivery. If no delivery is possible, this is null.

onProviderRemovedFromColony

public void onProviderRemovedFromColony(@NotNull
 @NotNull IRequestResolverProvider provider)
                                 throws IllegalArgumentException

Method used to indicate to this manager that Provider has been removed from the colony.

Specified by:

onProviderRemovedFromColony in interface IRequestManager

Parameters:

provider - The removed provider.

Throws:

IllegalArgumentException - is thrown when no provider with the same token is registered.

onRequesterRemovedFromColony

public void onRequesterRemovedFromColony(@NotNull
 @NotNull IRequester requester)
                                  throws IllegalArgumentException

Description copied from interface: IRequestManager

Method used to indicate to this manager that a Requster has been removed from the colony.

Specified by:

onRequesterRemovedFromColony in interface IRequestManager

Parameters:

requester - The removed requester.

Throws:

IllegalArgumentException - is thrown when no requester with the same token is registered.

onColonyUpdate

public void onColonyUpdate(@NotNull
 @NotNull Predicate<IRequest<?>> shouldTriggerReassign)

Method used to reassign requests based on a predicate.

Specified by:

onColonyUpdate in interface IRequestManager

Parameters:

shouldTriggerReassign - The predicate to determine if the request should be reassigned.

getPlayerResolver

@NotNull
public @NotNull IPlayerRequestResolver getPlayerResolver()

Get the player resolve.

Specified by:

getPlayerResolver in interface IRequestManager

Returns:

the player resolver object.

getRetryingRequestResolver

@NotNull
public @NotNull IRetryingRequestResolver getRetryingRequestResolver()

Description copied from interface: IRequestManager

Get the retrying request resolver.

Specified by:

getRetryingRequestResolver in interface IRequestManager

Returns:

The retrying request resolver.

getDataStoreManager

@NotNull
public @NotNull IDataStoreManager getDataStoreManager()

Description copied from interface: IRequestManager

Get the data store manager.

Specified by:

getDataStoreManager in interface IRequestManager

Returns:

The data store manager.

reset

public void reset()

Description copied from interface: IRequestManager

Called to reset the RS.

Specified by:

reset in interface IRequestManager

serializeNBT

public net.minecraft.nbt.CompoundTag serializeNBT()

Method used to serialize the current request system to NBT.

Specified by:

serializeNBT in interface net.minecraftforge.common.util.INBTSerializable<net.minecraft.nbt.CompoundTag>

Returns:

The NBTData that describes the current request system

deserializeNBT

public void deserializeNBT(net.minecraft.nbt.CompoundTag nbt)

Method used to deserialize the data inside the given nbt tag into this request system.

Specified by:

deserializeNBT in interface net.minecraftforge.common.util.INBTSerializable<net.minecraft.nbt.CompoundTag>

Parameters:

nbt - The data to deserialize.

serialize

public void serialize(IFactoryController controller,
 net.minecraft.network.FriendlyByteBuf buffer)

Description copied from interface: IRequestManager

serialize this request manager to the give FriendlyByteBuf

Specified by:

serialize in interface IRequestManager

Parameters:

controller - the controller.

buffer - the FriendlyByteBuf to serialize to.

deserialize

public void deserialize(IFactoryController controller,
 net.minecraft.network.FriendlyByteBuf buffer)

Description copied from interface: IRequestManager

deserialize this request manager from the give FriendlyByteBuf

Specified by:

deserialize in interface IRequestManager

Parameters:

controller - the controller.

buffer - the FriendlyByteBuf to deserialize from.

log

public void log(String message)

Description copied from interface: IRequestManager

Log a debug message.

Specified by:

log in interface IRequestManager

Parameters:

message - the message to log.

tick

public void tick()

Description copied from interface: ITickable

Default parameterless ticking implementation.

Specified by:

tick in interface ITickable

getRequestIdentitiesDataStore

@NotNull
public @NotNull IRequestIdentitiesDataStore getRequestIdentitiesDataStore()

Specified by:

getRequestIdentitiesDataStore in interface IStandardRequestManager

getRequestResolverIdentitiesDataStore

@NotNull
public @NotNull IRequestResolverIdentitiesDataStore getRequestResolverIdentitiesDataStore()

Specified by:

getRequestResolverIdentitiesDataStore in interface IStandardRequestManager

getProviderResolverAssignmentDataStore

@NotNull
public @NotNull IProviderResolverAssignmentDataStore getProviderResolverAssignmentDataStore()

Specified by:

getProviderResolverAssignmentDataStore in interface IStandardRequestManager

getRequestResolverRequestAssignmentDataStore

@NotNull
public @NotNull IRequestResolverRequestAssignmentDataStore getRequestResolverRequestAssignmentDataStore()

Specified by:

getRequestResolverRequestAssignmentDataStore in interface IStandardRequestManager

getRequestableTypeRequestResolverAssignmentDataStore

@NotNull
public @NotNull IRequestableTypeRequestResolverAssignmentDataStore getRequestableTypeRequestResolverAssignmentDataStore()

Specified by:

getRequestableTypeRequestResolverAssignmentDataStore in interface IStandardRequestManager

getProviderHandler

public IProviderHandler getProviderHandler()

Specified by:

getProviderHandler in interface IStandardRequestManager

getRequestHandler

public IRequestHandler getRequestHandler()

Specified by:

getRequestHandler in interface IStandardRequestManager

getResolverHandler

public IResolverHandler getResolverHandler()

Specified by:

getResolverHandler in interface IStandardRequestManager

getTokenHandler

public ITokenHandler getTokenHandler()

Specified by:

getTokenHandler in interface IStandardRequestManager

getUpdateHandler

public IUpdateHandler getUpdateHandler()

Specified by:

getUpdateHandler in interface IStandardRequestManager

getCurrentVersion

public int getCurrentVersion()

Specified by:

getCurrentVersion in interface IStandardRequestManager

setCurrentVersion

public void setCurrentVersion(int currentVersion)

Specified by:

setCurrentVersion in interface IStandardRequestManager