AmountBasedAggregatedDumpTradeStep (Open Patrician 1.1.0-SNAPSHOT API)

java.lang.Object
- ch.sahits.game.openpatrician.engine.player.tradesteps.AbstractAggregateDumpTradeStep
- - ch.sahits.game.openpatrician.engine.player.tradesteps.AmountBasedAggregatedDumpTradeStep

All Implemented Interfaces:

ITradeStep
```
public class AmountBasedAggregatedDumpTradeStep
extends AbstractAggregateDumpTradeStep
```
This dump sell step is conditional based on the amount of loaded wares on the ship. It is best used with a preceding sell step and then use this dump step to check if there is too much wares loaded and to dump them.

Author:

Andi Hotz, (c) Sahits GmbH, 2016 Created on Jul 24, 2016

- Field Summary
  
  Fields
  Modifier and Type Field Description
  
  private int maxAmount
  Maximal amount that should be on the ship.
- Constructor Summary
  
  Constructors
  Constructor Description
  
  AmountBasedAggregatedDumpTradeStep()
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  boolean execute()
  Execute the trade step.
  - Methods inherited from class ch.sahits.game.openpatrician.engine.player.tradesteps.AbstractAggregateDumpTradeStep
    addSellStep, toString
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - maxAmount
```
private int maxAmount
```
    Maximal amount that should be on the ship. If there is more loaded everything is dumped.
- Constructor Detail
  - AmountBasedAggregatedDumpTradeStep
```
public AmountBasedAggregatedDumpTradeStep()
```
- Method Detail
  - execute
```
public boolean execute()
```
    Description copied from interface: ITradeStep
    
    Execute the trade step.
    
    Specified by:
    
    execute in interface ITradeStep
    
    Overrides:
    
    execute in class AbstractAggregateDumpTradeStep
    
    Returns:
    
    true if the next step can be executed on completion or if the execution is triggered by the arrival of the ship in the next port.