Package org.rspeer.game.config.item.entry.impl

Class DefaultItemEntry

java.lang.Object

org.rspeer.game.config.item.entry.impl.DefaultItemEntry

All Implemented Interfaces:

Serializable, Cloneable, ItemEntry

Direct Known Subclasses:

DefaultFuzzyItemEntry, DefaultIdItemEntry, DefaultInterchangeableItemEntry

public class DefaultItemEntry
extends Object
implements ItemEntry

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.rspeer.game.config.item.entry.ItemEntry

ALL

Constructor Summary

Constructors

Constructor	Description
DefaultItemEntry()
DefaultItemEntry(String key, int minimumQuantity, int quantity, boolean stackable, boolean noted, RestockMeta restockMeta, boolean optional, Equipment.Slot equipmentSlot)

Method Summary

Modifier and Type	Method	Description
ItemEntry	clone()
ItemEntry	clone(RestockMeta restockMeta)
Equipment.Slot	getEquipmentSlot()
String	getKey()
int	getMinimumQuantity()
int	getQuantity()
RestockMeta	getRestockMeta()
ItemEntrySetup	getSetup()
InterchangeableItemEntry	interchange(String... names)
boolean	isNoted()
boolean	isOptional()
boolean	isStackable()
void	setSetup(ItemEntrySetup setup)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.rspeer.game.config.item.entry.ItemEntry

contained, contained, contained, contained, getContained, getContained

Constructor Detail

DefaultItemEntry

public DefaultItemEntry()

DefaultItemEntry

public DefaultItemEntry(String key,
                        int minimumQuantity,
                        int quantity,
                        boolean stackable,
                        boolean noted,
                        RestockMeta restockMeta,
                        boolean optional,
                        Equipment.Slot equipmentSlot)

Method Detail

getKey

public String getKey()

Specified by:

getKey in interface ItemEntry

Returns:

A key used as an identifier/debug info for the item. Should generally be the item name, unless it's fuzzy

getMinimumQuantity

public int getMinimumQuantity()

Specified by:

getMinimumQuantity in interface ItemEntry

Returns:

The minimum quantity allowed in this loadout for validation to pass

getQuantity

public int getQuantity()

Specified by:

getQuantity in interface ItemEntry

Returns:

The quantity of the item to take. If the quantity is defined as ItemEntry.ALL and the item is stackable, then in the context of banking, it indicates that the withdraw-all option should be used and the amount not be validated

See Also:

ItemEntry.isStackable()

clone

public ItemEntry clone()

Specified by:

clone in interface ItemEntry

interchange

public InterchangeableItemEntry interchange(String... names)

Specified by:

interchange in interface ItemEntry

clone

public ItemEntry clone(RestockMeta restockMeta)

Specified by:

clone in interface ItemEntry

isStackable

public boolean isStackable()

Specified by:

isStackable in interface ItemEntry

Returns:

true if this item is stackable

isNoted

public boolean isNoted()

Specified by:

isNoted in interface ItemEntry

getRestockMeta

public RestockMeta getRestockMeta()

Specified by:

getRestockMeta in interface ItemEntry

Returns:

A RestockMeta object detailing the restocking specifications of this item, or null if the item is not restockable, or doesn't need to be restocked

isOptional

public boolean isOptional()

Specified by:

isOptional in interface ItemEntry

Returns:

Whether this item is optional in the loadout or not. If it is marked as optional, any validation/contains/equals checks will ignore it

getEquipmentSlot

public Equipment.Slot getEquipmentSlot()

Specified by:

getEquipmentSlot in interface ItemEntry

Returns:

An Equipment.Slot if applicable, null otherwise

getSetup

public ItemEntrySetup getSetup()

Specified by:

getSetup in interface ItemEntry

Returns:

The ItemEntrySetup associated with this entry, or null if no setup is required

setSetup

public void setSetup(ItemEntrySetup setup)

Specified by:

setSetup in interface ItemEntry

Parameters:

setup - Adds a required setup for this entry