ShipyardState (OpenPatricianModel 0.7.0 API)

java.lang.Object
- ch.sahits.game.openpatrician.model.city.impl.ShipyardState

All Implemented Interfaces:

IShipyard
```
@Component
 @Scope(value="prototype")
public class ShipyardState
extends Object
implements IShipyard
```
Implementation of the shipyard model.

Author:

Andi Hotz, (c) Sahits GmbH, 2013 Created on Mar 9, 2013

Field Summary

Fields
Modifier and Type	Field and Description
`private int`	`baseSalaryPerDay`
`private Map<IShipDueDate,Optional<TimedTask>>`	`buildList`
`private int`	`buildTimeCog`
`private int`	`buildTimeCrayer`
`private int`	`buildTimeHolk`
`private int`	`buildTimeSnaikka`
`private ICity`	`city`
`private Date`	`date`
`private double`	`experience` Value between 0 and 1 detailing the experience of the ship yard crew (the higher the better)
`private org.apache.logging.log4j.Logger`	`logger`
`private IMap`	`map`
`private int`	`materialUnitCost`
`private DependentPropertyInitializer`	`propertyInitializer`
`private Map<IShipDueDate,Optional<TimedTask>>`	`refitList`
`private Map<IShipDueDate,Optional<TimedTask>>`	`repairList`
`private int`	`repairTimeCog`
`private int`	`repairTimeCrayer`
`private int`	`repairTimeHolk`
`private int`	`repairTimeSnaikka`
`private Random`	`rnd`
`private TimedUpdatableTaskList`	`taskList`

Constructor Summary

Constructors
Constructor and Description

ShipyardState(ICity city)

Constructors
Constructor and Description
`ShipyardState(ICity city)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addShipBuildingOrder(IShipDueDate dueDate, Optional<TimedTask> task)` Add an order for building a new ship to the list.
`void`	`addShipRefitOrder(IShipDueDate dueDate, Optional<TimedTask> task)` Add an order for refitting a ship to the list.
`void`	`addShipRepairOrder(IShipDueDate dueDate, Optional<TimedTask> task)` Add an order for repairing a ship to the list.
`int`	`calculateBuildTime(EShipType type)` Calculate the build time for the ship of type.
`int`	`calculateConstructionCosts(EShipType type)` Calculate the labor costs for building a new ship of the indicated type.
`int`	`calculateRefitCosts(EShipType type, int levels)` Calculate the labor costs for the refit based on the ship type and how many levels should be upgraded.
`int`	`calculateRefitTime(EShipType type)` Calculate the time in days it takes for refitting.
`int`	`calculateRepairCosts(int repairTime, int materialCosts)` Calculate the repair costs.
`int`	`calculateRepairMaterialCosts(IShip ship, int damage)` Calculate the material costs for the repair.
`int`	`calculateRepairTime(EShipType type)` Calculate the repair time for the ship of type.
`private int`	`calculateSaleryPerDay()` Salery is defined by the experiance
`void`	`cancelRepair(IShip ship)` Cancel the repair of the ship.
`void`	`cancelShipBuildingOrder(org.joda.time.DateTime finish)` Cancel the order of the building, finished on the given date.
`void`	`cleanup()` Remove entries that lie in the past.
`EShipType[]`	`getBuildableShipTypes()` Retrieve a list of all the types of ships this yard can build.
`org.joda.time.DateTime`	`getBuildCompleteDate(EShipType type)` Retrieve the date when the building of a new ship will be finished.
`List<IShipDueDate>`	`getShipBuildingList()` Retrieve an immutable list of the ships that are ordered to be built on this shipyard.
`List<IShipDueDate>`	`getShipRepairList()` Retrieve the list of all ships that are to be repaired.
`private double`	`getShipSize(IShip ship)`
`List<IShipDueDate>`	`getShipUpgradeList()` Retrieve the list of all ships that are to be upgraded.
`void`	`initializeExperience()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ch.sahits.game.openpatrician.model.city.IShipyard
getCity

- Field Detail
  - logger
```
private final org.apache.logging.log4j.Logger logger
```
  - buildTimeSnaikka
```
@DependentValue(value="shipyard.build.time.snaikka")
private int buildTimeSnaikka
```
  - buildTimeCrayer
```
@DependentValue(value="shipyard.build.time.crayer")
private int buildTimeCrayer
```
  - buildTimeCog
```
@DependentValue(value="shipyard.build.time.cog")
private int buildTimeCog
```
  - buildTimeHolk
```
@DependentValue(value="shipyard.build.time.holk")
private int buildTimeHolk
```
  - repairTimeSnaikka
```
@DependentValue(value="shipyard.repair.time.snaikka")
private int repairTimeSnaikka
```
  - repairTimeCrayer
```
@DependentValue(value="shipyard.repair.time.crayer")
private int repairTimeCrayer
```
  - repairTimeCog
```
@DependentValue(value="shipyard.repair.time.cog")
private int repairTimeCog
```
  - repairTimeHolk
```
@DependentValue(value="shipyard.repair.time.holk")
private int repairTimeHolk
```
  - materialUnitCost
```
@Value(value="${shipyard.material.cost.per.unit}")
private int materialUnitCost
```
  - baseSalaryPerDay
```
@Value(value="${shipyard.salary.per.day}")
private int baseSalaryPerDay
```
  - repairList
```
private final Map<IShipDueDate,Optional<TimedTask>> repairList
```
  - buildList
```
private final Map<IShipDueDate,Optional<TimedTask>> buildList
```
  - refitList
```
private final Map<IShipDueDate,Optional<TimedTask>> refitList
```
  - experience
```
private double experience
```
    Value between 0 and 1 detailing the experience of the ship yard crew (the higher the better)
  - date
```
@Autowired
private Date date
```
  - rnd
```
@Autowired
private Random rnd
```
  - city
```
private final ICity city
```
  - taskList
```
@Autowired
private TimedUpdatableTaskList taskList
```
  - map
```
@Autowired
private IMap map
```
  - propertyInitializer
```
@Autowired
private DependentPropertyInitializer propertyInitializer
```
- Constructor Detail
  - ShipyardState
```
public ShipyardState(ICity city)
```
- Method Detail
  - initializeExperience
```
@PostConstruct
public void initializeExperience()
```
  - getShipBuildingList
```
public List<IShipDueDate> getShipBuildingList()
```
    Description copied from interface: IShipyard
    
    Retrieve an immutable list of the ships that are ordered to be built on this shipyard.
    
    Specified by:
    
    getShipBuildingList in interface IShipyard
    
    Returns:
    
    immutable list of ship due dates.
  - getShipUpgradeList
```
public List<IShipDueDate> getShipUpgradeList()
```
    Description copied from interface: IShipyard
    
    Retrieve the list of all ships that are to be upgraded.
    
    Specified by:
    
    getShipUpgradeList in interface IShipyard
    
    Returns:
    
    immutable list of all the upgrading ships
  - addShipBuildingOrder
```
public void addShipBuildingOrder(IShipDueDate dueDate,
                                 Optional<TimedTask> task)
```
    Description copied from interface: IShipyard
    
    Add an order for building a new ship to the list.
    
    Specified by:
    
    addShipBuildingOrder in interface IShipyard
    
    Parameters:
    
    dueDate - when the ship is finished building
    
    task - that is executed on completion.
  - cancelShipBuildingOrder
```
public void cancelShipBuildingOrder(org.joda.time.DateTime finish)
```
    Description copied from interface: IShipyard
    
    Cancel the order of the building, finished on the given date.
    
    Specified by:
    
    cancelShipBuildingOrder in interface IShipyard
    
    Parameters:
    
    finish - date
  - getShipRepairList
```
public List<IShipDueDate> getShipRepairList()
```
    Description copied from interface: IShipyard
    
    Retrieve the list of all ships that are to be repaired.
    
    Specified by:
    
    getShipRepairList in interface IShipyard
    
    Returns:
    
    immutable list of all the repairing ships
  - addShipRepairOrder
```
public void addShipRepairOrder(IShipDueDate dueDate,
                               Optional<TimedTask> task)
```
    Description copied from interface: IShipyard
    
    Add an order for repairing a ship to the list.
    
    Specified by:
    
    addShipRepairOrder in interface IShipyard
    
    Parameters:
    
    dueDate - when the ship is finished repairing
    
    task - that is executed on completion.
  - calculateRepairMaterialCosts
```
public int calculateRepairMaterialCosts(IShip ship,
                                        int damage)
```
    Description copied from interface: IShipyard
    
    Calculate the material costs for the repair.
    
    Specified by:
    
    calculateRepairMaterialCosts in interface IShipyard
    
    Returns:
  - getShipSize
```
private double getShipSize(IShip ship)
```
  - calculateRepairCosts
```
public int calculateRepairCosts(int repairTime,
                                int materialCosts)
```
    Description copied from interface: IShipyard
    
    Calculate the repair costs.
    
    Specified by:
    
    calculateRepairCosts in interface IShipyard
    
    Returns:
  - calculateSaleryPerDay
```
private int calculateSaleryPerDay()
```
    Salery is defined by the experiance
    
    Returns:
  - cancelRepair
```
public void cancelRepair(IShip ship)
```
    Description copied from interface: IShipyard
    
    Cancel the repair of the ship. No damage will be repaired
    
    Specified by:
    
    cancelRepair in interface IShipyard
    
    Parameters:
    
    ship - which's repair order is to be canceled
  - addShipRefitOrder
```
public void addShipRefitOrder(IShipDueDate dueDate,
                              Optional<TimedTask> task)
```
    Description copied from interface: IShipyard
    
    Add an order for refitting a ship to the list.
    
    Specified by:
    
    addShipRefitOrder in interface IShipyard
    
    Parameters:
    
    dueDate - when the ship is refitted
    
    task - that is executed on completion.
  - calculateRefitTime
```
public int calculateRefitTime(EShipType type)
```
    Description copied from interface: IShipyard
    
    Calculate the time in days it takes for refitting.
    
    Specified by:
    
    calculateRefitTime in interface IShipyard
    
    Parameters:
    
    type - destination level
    
    Returns:
    
    time in days.
  - getBuildCompleteDate
```
public org.joda.time.DateTime getBuildCompleteDate(EShipType type)
```
    Description copied from interface: IShipyard
    
    Retrieve the date when the building of a new ship will be finished.
    
    Specified by:
    
    getBuildCompleteDate in interface IShipyard
    
    Parameters:
    
    type - of the ship to be built
    
    Returns:
    
    end date of the building
  - calculateBuildTime
```
public int calculateBuildTime(EShipType type)
```
    Calculate the build time for the ship of type.
    
    Specified by:
    
    calculateBuildTime in interface IShipyard
    
    Parameters:
    
    type -
    
    Returns:
  - calculateRepairTime
```
public int calculateRepairTime(EShipType type)
```
    Calculate the repair time for the ship of type.
    
    Specified by:
    
    calculateRepairTime in interface IShipyard
    
    Parameters:
    
    type -
    
    Returns:
  - cleanup
```
public void cleanup()
```
    Remove entries that lie in the past. This are orders that are fullfiled and can be removed.
  - calculateRefitCosts
```
public int calculateRefitCosts(EShipType type,
                               int levels)
```
    Description copied from interface: IShipyard
    
    Calculate the labor costs for the refit based on the ship type and how many levels should be upgraded.
    
    Specified by:
    
    calculateRefitCosts in interface IShipyard
    
    Returns:
  - calculateConstructionCosts
```
public int calculateConstructionCosts(EShipType type)
```
    Description copied from interface: IShipyard
    
    Calculate the labor costs for building a new ship of the indicated type.
    
    Specified by:
    
    calculateConstructionCosts in interface IShipyard
    
    Parameters:
    
    type - of the ship
    
    Returns:
    
    costs.
  - getBuildableShipTypes
```
public EShipType[] getBuildableShipTypes()
```
    Description copied from interface: IShipyard
    
    Retrieve a list of all the types of ships this yard can build.
    
    Specified by:
    
    getBuildableShipTypes in interface IShipyard
    
    Returns:

Class ShipyardState

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface ch.sahits.game.openpatrician.model.city.IShipyard

Field Detail

logger

buildTimeSnaikka

buildTimeCrayer

buildTimeCog

buildTimeHolk

repairTimeSnaikka

repairTimeCrayer

repairTimeCog

repairTimeHolk

materialUnitCost

baseSalaryPerDay

repairList

buildList

refitList

experience

date

rnd

city

taskList

map

propertyInitializer

Constructor Detail

ShipyardState

Method Detail

initializeExperience

getShipBuildingList

getShipUpgradeList

addShipBuildingOrder

cancelShipBuildingOrder

getShipRepairList

addShipRepairOrder

calculateRepairMaterialCosts

getShipSize

calculateRepairCosts

calculateSaleryPerDay

cancelRepair

addShipRefitOrder

calculateRefitTime

getBuildCompleteDate

calculateBuildTime

calculateRepairTime

cleanup

calculateRefitCosts

calculateConstructionCosts

getBuildableShipTypes