org.spongepowered.api.item.merchant

Interface TradeOffer.Builder

All Superinterfaces:

DataBuilder<TradeOffer>, ResettableBuilder<TradeOffer,DataBuilder<TradeOffer>>

Enclosing interface:

TradeOffer

public static interface TradeOffer.Builder
extends DataBuilder<TradeOffer>

Represents a builder to generate immutable TradeOffers.

Method Summary

Modifier and Type	Method and Description
TradeOffer	build() Creates a new TradeOffer instance with the current state of the builder.
TradeOffer.Builder	canGrantExperience(boolean experience) Sets the trade offer to be generated to grant experience upon use.
TradeOffer.Builder	firstBuyingItem(ItemStack item) Sets the first selling item of the trade offer to be generated.
TradeOffer.Builder	from(TradeOffer offer) Sets all the settings of this builder with the provided trade offer as a blueprint.
TradeOffer.Builder	maxUses(int maxUses) Sets the maximum uses the generated trade offer will have.
TradeOffer.Builder	reset() Clears all settings of this builder.
TradeOffer.Builder	secondBuyingItem(ItemStack item) Sets the second selling item of the trade offer to be generated.
TradeOffer.Builder	sellingItem(ItemStack item) Sets the selling item of the trade offer to be generated.
TradeOffer.Builder	uses(int uses) Sets the existing uses of the trade offer to be generated.

Methods inherited from interface org.spongepowered.api.data.persistence.DataBuilder

build

Method Detail

firstBuyingItem

TradeOffer.Builder firstBuyingItem(ItemStack item)

Sets the first selling item of the trade offer to be generated.

Trade offers require at least one item to be generated.

Parameters:

item - The first item to buy

Returns:

This builder

secondBuyingItem

TradeOffer.Builder secondBuyingItem(ItemStack item)

Sets the second selling item of the trade offer to be generated.

Parameters:

item - The second item to buy

Returns:

This builder

sellingItem

TradeOffer.Builder sellingItem(ItemStack item)

Sets the selling item of the trade offer to be generated.

Parameters:

item - The item to sell

Returns:

This builder

uses

TradeOffer.Builder uses(int uses)

Sets the existing uses of the trade offer to be generated. A trade offer will become unusable when the uses surpasses the max uses.

Parameters:

uses - The uses

Returns:

This builder

maxUses

TradeOffer.Builder maxUses(int maxUses)

Sets the maximum uses the generated trade offer will have. A trade offer will become unusable when the uses surpasses the max uses.

Parameters:

maxUses - The maximum uses of the trade offer

Returns:

This builder

canGrantExperience

TradeOffer.Builder canGrantExperience(boolean experience)

Sets the trade offer to be generated to grant experience upon use.

Parameters:

experience - Whether the offer will grant experience

Returns:

This builder

build

TradeOffer build()
          throws IllegalStateException

Creates a new TradeOffer instance with the current state of the builder.

Returns:

A new trade offer instance

Throws:

IllegalStateException - If the resulting trade offer would be invalid

from

TradeOffer.Builder from(TradeOffer offer)

Sets all the settings of this builder with the provided trade offer as a blueprint.

Specified by:

from in interface DataBuilder<TradeOffer>

Specified by:

from in interface ResettableBuilder<TradeOffer,DataBuilder<TradeOffer>>

Parameters:

offer - The offer to copy

Returns:

This builder

reset

TradeOffer.Builder reset()

Clears all settings of this builder.

Specified by:

reset in interface DataBuilder<TradeOffer>

Specified by:

reset in interface ResettableBuilder<TradeOffer,DataBuilder<TradeOffer>>

Returns:

This builder