Package net.storm.api.items

Enum Class WithdrawMode

java.lang.Object
java.lang.Enum<WithdrawMode>
net.storm.api.items.WithdrawMode
All Implemented Interfaces:
Serializable, Comparable<WithdrawMode>, Constable
public enum WithdrawMode extends Enum<WithdrawMode>
Represents the withdrawal modes available when withdrawing items from the bank.

This enum defines how items should be withdrawn from the bank, specifically whether items should be withdrawn as notes or as regular items.

See Also:
  • IBank
  • invalid reference 
    IBankItem

  • Enum Constant Details

    • NOTED

      public static final WithdrawMode NOTED
      Withdraw items in noted form.

      Noted items stack in the inventory regardless of whether the item normally stacks. This is useful for withdrawing large quantities of items. Note that not all items can be noted.

    • ITEM

      public static final WithdrawMode ITEM
      Withdraw items in their regular (un-noted) form.

      Items will be withdrawn in their standard form. Non-stackable items will occupy one inventory slot each.

    • DEFAULT

      public static final WithdrawMode DEFAULT
      Use the bank's current default withdrawal mode.

      The withdrawal mode will match whatever is currently selected in the bank interface (either noted or un-noted).

  • Method Details

    • values

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