Package com.minecolonies.api.colony.requestsystem.request

Enum Class RequestState

java.lang.Object
java.lang.Enum<RequestState>
com.minecolonies.api.colony.requestsystem.request.RequestState
All Implemented Interfaces:
Serializable, Comparable<RequestState>, Constable
public enum RequestState extends Enum<RequestState>
Enum used to describe the state of a Request.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ASSIGNED
    State for a request that has been assigned, yet it has not been started.
    ASSIGNING
    State for a request that is being assigned.
    CANCELLED
    State for a request that has been cancelled.
    COMPLETED
    State for a request that has been completed.
    CREATED
    Default state for a not registered request.
    FAILED
    State used to indicate a truly failed request.
    FINALIZING
    State used to indicate that a request is cancelled overruled, yet processing is still continuing to ensure proper cleanup.
    FOLLOWUP_IN_PROGRESS
    State for a requests, who's resolving has been completed, but who's followups are still in processing stages.
    IN_PROGRESS
    State for a request on which is being worked.
    OVERRULED
    State for a request when it has been forcefully fullfilled by a player
    RECEIVED
    State used to indicate that this request has been received by the requester.
    REPORTED
    State for a request that has been registered, yet not resolved.
    RESOLVED
    States for a request who's primary processing has been completed.

  • Method Summary

    Modifier and Type
    Method
    Description
    static RequestState
    deserialize(net.minecraft.nbt.IntTag nbt)
    Method used to deserialize a RequestState from NBT
    static RequestState
    deserialize(net.minecraft.network.FriendlyByteBuf buffer)
    Method used to deserialize a RequestState from a packet buffer
    net.minecraft.nbt.IntTag
    serialize()
    Method used to serialize a state to NBT.
    void
    serialize(net.minecraft.network.FriendlyByteBuf buffer)
    Method used to serialize a state to a packet buffer.
    static RequestState
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static RequestState[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • CREATED

      public static final RequestState CREATED
      Default state for a not registered request.

    • REPORTED

      public static final RequestState REPORTED
      State for a request that has been registered, yet not resolved.

    • ASSIGNING

      public static final RequestState ASSIGNING
      State for a request that is being assigned.

    • ASSIGNED

      public static final RequestState ASSIGNED
      State for a request that has been assigned, yet it has not been started.

    • IN_PROGRESS

      public static final RequestState IN_PROGRESS
      State for a request on which is being worked.

    • RESOLVED

      public static final RequestState RESOLVED
      States for a request who's primary processing has been completed. Followup processing still needs to be determined.

    • FOLLOWUP_IN_PROGRESS

      public static final RequestState FOLLOWUP_IN_PROGRESS
      State for a requests, who's resolving has been completed, but who's followups are still in processing stages.

    • COMPLETED

      public static final RequestState COMPLETED
      State for a request that has been completed.

    • OVERRULED

      public static final RequestState OVERRULED
      State for a request when it has been forcefully fullfilled by a player

    • CANCELLED

      public static final RequestState CANCELLED
      State for a request that has been cancelled.

    • RECEIVED

      public static final RequestState RECEIVED
      State used to indicate that this request has been received by the requester.

    • FINALIZING

      public static final RequestState FINALIZING
      State used to indicate that a request is cancelled overruled, yet processing is still continuing to ensure proper cleanup.

    • FAILED

      public static final RequestState FAILED
      State used to indicate a truly failed request.

  • Method Details

    • values

      public static RequestState[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static RequestState valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • deserialize

      public static RequestState deserialize(net.minecraft.nbt.IntTag nbt)
      Method used to deserialize a RequestState from NBT
      Parameters:
      nbt - The nbt to deserialize from.
      Returns:
      The RequestState that is stored in the given NBT.

    • serialize

      public net.minecraft.nbt.IntTag serialize()
      Method used to serialize a state to NBT.
      Returns:
      The NBT representation of the state.

    • deserialize

      public static RequestState deserialize(net.minecraft.network.FriendlyByteBuf buffer)
      Method used to deserialize a RequestState from a packet buffer
      Parameters:
      buffer - The buffer to deserialize from.
      Returns:
      The RequestState that is stored in the given NBT.

    • serialize

      public void serialize(net.minecraft.network.FriendlyByteBuf buffer)
      Method used to serialize a state to a packet buffer.
      Parameters:
      buffer - The buffer to write to.