Package com.realtime.crossfire.jxclient.items

Enum Class InventoryFilter

java.lang.Object

java.lang.Enum<InventoryFilter>

com.realtime.crossfire.jxclient.items.InventoryFilter

All Implemented Interfaces:

Serializable, Comparable<InventoryFilter>, Constable

public enum InventoryFilter
extends Enum<InventoryFilter>

A filter option for the inventory view.

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
ALL	Shows all items.
APPLIED	Shows applied items.
CURSED	Shows cursed or damned items.
LOCKED	Shows locked items.
MAGICAL	Shows magical items.
NON_MAGICAL	Shows non-magical items.
UNAPPLIED	Shows non-applied items.
UNIDENTIFIED	Shows unidentified items.
UNLOCKED	Shows unlocked items.
UNPAID	Shows unpaid items.

Method Summary

Modifier and Type	Method	Description
abstract boolean	matches(@NotNull CfItem item)	Returns whether an CfItem matches this filter.
static InventoryFilter	valueOf(String name)	Returns the enum constant of this class with the specified name.
static InventoryFilter[]	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

ALL

public static final InventoryFilter ALL

Shows all items.

APPLIED

public static final InventoryFilter APPLIED

Shows applied items.

UNAPPLIED

public static final InventoryFilter UNAPPLIED

Shows non-applied items.

UNPAID

public static final InventoryFilter UNPAID

Shows unpaid items.

CURSED

public static final InventoryFilter CURSED

Shows cursed or damned items.

MAGICAL

public static final InventoryFilter MAGICAL

Shows magical items.

NON_MAGICAL

public static final InventoryFilter NON_MAGICAL

Shows non-magical items.

LOCKED

public static final InventoryFilter LOCKED

Shows locked items.

UNLOCKED

public static final InventoryFilter UNLOCKED

Shows unlocked items.

UNIDENTIFIED

public static final InventoryFilter UNIDENTIFIED

Shows unidentified items.

Method Details

values

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

matches

public abstract boolean matches(@NotNull
 @NotNull CfItem item)

Returns whether an CfItem matches this filter.

Parameters:

item - the item

Returns:

whether the item matches