Package com.griefdefender.api.claim

Enum Class ClaimResultType

java.lang.Object
java.lang.Enum<ClaimResultType>
com.griefdefender.api.claim.ClaimResultType
All Implemented Interfaces:
Serializable, Comparable<ClaimResultType>, Constable
public enum ClaimResultType extends Enum<ClaimResultType>
Used to provide more information to a plugin when a claim action is successful or cancelled.

  • Enum Constant Details

    • CLAIM_ALREADY_EXISTS

      public static final ClaimResultType CLAIM_ALREADY_EXISTS
      Returned if a claim already exists.

    • CLAIM_NOT_FOUND

      public static final ClaimResultType CLAIM_NOT_FOUND
      Returned if a claim is not found.

    • CLAIMS_DISABLED

      public static final ClaimResultType CLAIMS_DISABLED
      Returned if claims are not enabled in a world.

    • ABOVE_MAX_LEVEL

      public static final ClaimResultType ABOVE_MAX_LEVEL
      Returned if a claim's y level goes above a player's PlayerData.getMaxClaimLevel().

    • BELOW_MIN_LEVEL

      public static final ClaimResultType BELOW_MIN_LEVEL
      Returned if a claim's y level goes below a player's PlayerData.getMinClaimLevel().

    • BELOW_MIN_SIZE_X

      public static final ClaimResultType BELOW_MIN_SIZE_X
      Returned if a claim's x size goes below a player's PlayerData.getMinClaimX(ClaimType).

    • BELOW_MIN_SIZE_Y

      public static final ClaimResultType BELOW_MIN_SIZE_Y
      Returned if a claim's y size goes below a player's PlayerData.getMinClaimY(ClaimType).

    • BELOW_MIN_SIZE_Z

      public static final ClaimResultType BELOW_MIN_SIZE_Z
      Returned if a claim's z size goes below a player's PlayerData.getMinClaimZ(ClaimType).

    • CLAN_NOT_FOUND

      public static final ClaimResultType CLAN_NOT_FOUND
      Returned if a
      invalid reference 
      Clan
      could not be located.

    • ECONOMY_ACCOUNT_NOT_FOUND

      public static final ClaimResultType ECONOMY_ACCOUNT_NOT_FOUND
      Returned if no economy account was found.

    • ECONOMY_NOT_ENOUGH_FUNDS

      public static final ClaimResultType ECONOMY_NOT_ENOUGH_FUNDS
      Returned if a land purchase is made without enough funds.

    • ECONOMY_DEPOSIT_FAIL

      public static final ClaimResultType ECONOMY_DEPOSIT_FAIL
      Returned if required claim funds could not be deposited into an
      invalid reference 
      Account
      .

    • ECONOMY_WITHDRAW_FAIL

      public static final ClaimResultType ECONOMY_WITHDRAW_FAIL
      Returned if required claim funds could not be withdrawn from an
      invalid reference 
      Account
      .

    • EXCEEDS_MAX_CLAIMABLE_BLOCKS

      public static final ClaimResultType EXCEEDS_MAX_CLAIMABLE_BLOCKS
      Returned if a player attempts to create or resize a claim past their PlayerData.getMaxClaimableBlocks().

    • EXCEEDS_MAX_CLAIM_LIMIT

      public static final ClaimResultType EXCEEDS_MAX_CLAIM_LIMIT
      Returned if a player attempts to create a claim past their
      invalid reference 
      PlayerData#getCreateClaimLimit()
      .

    • EXCEEDS_MAX_SIZE_X

      public static final ClaimResultType EXCEEDS_MAX_SIZE_X
      Returned if a claim's x size exceeds a player's PlayerData.getMaxClaimX(ClaimType).

    • EXCEEDS_MAX_SIZE_Y

      public static final ClaimResultType EXCEEDS_MAX_SIZE_Y
      Returned if a claim's y size exceeds a player's PlayerData.getMaxClaimY(ClaimType).

    • EXCEEDS_MAX_SIZE_Z

      public static final ClaimResultType EXCEEDS_MAX_SIZE_Z
      Returned if a claim's z size exceeds a player's PlayerData.getMaxClaimZ(ClaimType).

    • FAILURE

      public static final ClaimResultType FAILURE
      Returned if a claim action did not complete successfully.

    • INSUFFICIENT_CLAIM_BLOCKS

      public static final ClaimResultType INSUFFICIENT_CLAIM_BLOCKS
      Returned if a player doesn't have enough claim blocks to perform a claim action.

    • NOT_ENOUGH_FUNDS

      public static final ClaimResultType NOT_ENOUGH_FUNDS
      Returned if a player doesn't have enough funds to perform an economy action.

    • OUTSIDE_WORLD_BORDER

      public static final ClaimResultType OUTSIDE_WORLD_BORDER
      Returned if a claim is resized or created outside the world border.

    • RENT_CLAIM_MODIFY

      public static final ClaimResultType RENT_CLAIM_MODIFY
      Returned if a renter attempts to modify a claim such as resize or delete.

    • RENT_UNPAID_BALANCE

      public static final ClaimResultType RENT_UNPAID_BALANCE
      Returned if a claim is requested for deletion with a rent balance.

    • REQUIRES_OWNER

      public static final ClaimResultType REQUIRES_OWNER
      Returned if a claim action requires an owner's permission.

    • WORLD_NOT_FOUND

      public static final ClaimResultType WORLD_NOT_FOUND
      Returned if a world could not be loaded by uuid.

    • WRONG_CLAIM_TYPE

      public static final ClaimResultType WRONG_CLAIM_TYPE
      Returned if an attempted claim action uses wrong ClaimType.

    • OVERLAPPING_CLAIM

      public static final ClaimResultType OVERLAPPING_CLAIM
      Returns a list of overlapping claims. See ClaimResult.getClaims()

    • CLAIM_EVENT_CANCELLED

      public static final ClaimResultType CLAIM_EVENT_CANCELLED
      Returns one or more claims that were cancelled. Note: If deleting a claim with child claims, this may return a list of one or more claims in result that could not be deleted due to event cancellations.

    • SUCCESS

      public static final ClaimResultType SUCCESS
      Returns successful claim in result.

      Examples of results:

      • Created claim
      • Deleted claim
      • Resized claim
      • Transferred claim

  • Method Details

    • values

      public static ClaimResultType[] 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 ClaimResultType 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