Bank

java.lang.Object
- shared.model.Bank

All Implemented Interfaces:

java.io.Serializable
```
public class Bank
extends java.lang.Object
implements java.io.Serializable
```
The bank class holds resource cards, game pieces, and dev cards

Author:

matthewcarlson, garrettegan, parker ridd

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`private int[]`	`devCards`
`private int[]`	`newDevCards`
`private int`	`numberDevCardTypes`
`private int`	`numberPieceTypes`
`private int`	`numberResourceTypes`
`private int[]`	`pieces`
`private int[]`	`resources`
`private static long`	`serialVersionUID`
`private int`	`solidersInPlay`

Constructor Summary

Constructors
Constructor and Description

Bank()
Creates a bank

Constructors
Constructor and Description
`Bank()` Creates a bank

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`buildCity()` Removes resource cards, if allowed, needed to build a city (two wheat, three ore, one city)
`void`	`buildRoad()` Removes resource cards, if allowed, needed to build a road (one wood, one brick, one road)
`void`	`buildSettlement()` Removes resource cards, if allowed, needed to build a settlement (one wood, one brick, one sheep, one wheat, one settlement)
`void`	`buyDevCard()` Removes resource cards, if allowed, needed to buy a development card (one wheat, one sheep, one ore)
`boolean`	`canBuildCity()` Checks if has enough cards to build a city (two wheat, three ore, one city)
`boolean`	`canBuildRoad()` Checks if has enough cards to build a road (one wood, one brick, one road)
`boolean`	`canBuildSettlement()` Checks if has enough cards to build a settlement (one wood, one brick, one sheep, one wheat, one settlement)
`boolean`	`canBuyDevCard()` Checks if has enough cards to buy a development card (one wheat, one sheep, one ore)
`boolean`	`equals(java.lang.Object obj)`
`int`	`getArmyCount()` A little bit of a simple method but eh.
`DevCardType`	`getDevCard()` This gets a dev card which by default are shuffled when given.
`void`	`getDevCard(DevCardType type)` Gets a dev card of the specific type (taking it from the bank)
`int`	`getDevCardCount()` Gets the total number of dev cards held
`int`	`getDevCardCount(DevCardType type)` Gets the number of dev cards of a type held
`int`	`getNewDevCardCount(DevCardType type)`
`int`	`getNumberSolidersRecruited()` Returns the number of soliders you've played
`void`	`getPiece(PieceType type)` Attempts to get a piece (road, settlement, city).
`int`	`getPieceCount(PieceType type)` Gets the number of pieces available for a type held
`void`	`getResource(ResourceType type)` Attempts to get a resource from the bank
`void`	`getResource(ResourceType type, int amount)` Gets a resource of the type requested at the amount requested
`int`	`getResourceCount()` Gets the current number of all held resources
`int`	`getResourceCount(ResourceType type)` returns the number of resources for a specified type
`void`	`giveDevCard(DevCardType type)` Gives the bank one dev card- it will be shuffled into pile
`private void`	`giveDevCard(DevCardType type, int amount)`
`void`	`giveNewDevCard(DevCardType type)`
`void`	`givePiece(PieceType type)` Gives the bank one piece
`void`	`givePiece(PieceType type, int amount)`
`void`	`giveResource(ResourceType type)` Give a single resource of type
`void`	`giveResource(ResourceType type, int amount)` Gives the bank amount of type resource of type
`void`	`giveResourcesFor(PieceType piece)` Gives the bank the resources to buy this piece
`void`	`giveResourcesForDevCard()` Gives the bank the resources for a dev card
`int`	`hashCode()`
`void`	`newToOldDevs()`
`void`	`recruitSolider()` Adds one to the number of soliders you've played
`void`	`resetToBankDefaults()`
`void`	`resetToPlayerDefaults()` Resets the bank to the defaults of a player
`java.lang.String`	`resourcesToString()`
`ResourceType`	`takeRandomResource()` Gives a random resource from this player to the bank
`java.lang.String`	`toString()`

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

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
  - resources
```
private int[] resources
```
  - devCards
```
private int[] devCards
```
  - pieces
```
private int[] pieces
```
  - numberResourceTypes
```
private int numberResourceTypes
```
  - numberDevCardTypes
```
private int numberDevCardTypes
```
  - numberPieceTypes
```
private int numberPieceTypes
```
  - solidersInPlay
```
private int solidersInPlay
```
  - newDevCards
```
private int[] newDevCards
```
- Constructor Detail
  - Bank
```
public Bank()
```
    Creates a bank
- Method Detail
  - resetToPlayerDefaults
```
public void resetToPlayerDefaults()
```
    Resets the bank to the defaults of a player
  - resetToBankDefaults
```
public void resetToBankDefaults()
```
  - getResource
```
public void getResource(ResourceType type)
                 throws ModelException
```
    Attempts to get a resource from the bank
    
    Parameters:
    
    type - the type requested
    
    Throws:
    
    if - there don't have the resource
    
    ModelException
  - getResource
```
public void getResource(ResourceType type,
                        int amount)
                 throws ModelException
```
    Gets a resource of the type requested at the amount requested
    
    Parameters:
    
    type -
    
    amount -
    
    Throws:
    
    ModelException - if not enough of type
  - getNumberSolidersRecruited
```
public int getNumberSolidersRecruited()
```
    Returns the number of soliders you've played
    
    Returns:
  - recruitSolider
```
public void recruitSolider()
```
    Adds one to the number of soliders you've played
  - getDevCard
```
public void getDevCard(DevCardType type)
                throws ModelException
```
    Gets a dev card of the specific type (taking it from the bank)
    
    Parameters:
    
    type -
    
    Throws:
    
    ModelException
  - getPiece
```
public void getPiece(PieceType type)
              throws ModelException
```
    Attempts to get a piece (road, settlement, city). Local since it you can only get pieces out of bank by buying them
    
    Parameters:
    
    type - it can be anything but the robber
    
    Throws:
    
    if - there don't have the resource or if type robber
    
    ModelException
  - getDevCard
```
public DevCardType getDevCard()
                       throws ModelException
```
    This gets a dev card which by default are shuffled when given.
    
    Returns:
    
    the type of the card you received or UNKNOWN if there are no more cards left
    
    Throws:
    
    if - there don't have the resource
    
    ModelException
  - giveResource
```
public void giveResource(ResourceType type)
                  throws ModelException
```
    Give a single resource of type
    
    Parameters:
    
    type -
    
    Throws:
    
    ModelException
  - giveResource
```
public void giveResource(ResourceType type,
                         int amount)
                  throws ModelException
```
    Gives the bank amount of type resource of type
    
    Parameters:
    
    type - the resource given
    
    the - amount to give
    
    Throws:
    
    ModelException
  - takeRandomResource
```
public ResourceType takeRandomResource()
                                throws ModelException
```
    Gives a random resource from this player to the bank
    
    Returns:
    
    the resourcetype taken; null if this player doesn't have any resources
    
    Throws:
    
    ModelException
  - givePiece
```
public void givePiece(PieceType type)
               throws ModelException
```
    Gives the bank one piece
    
    Parameters:
    
    type -
    
    Throws:
    
    ModelException - if type robber passed in
  - givePiece
```
public void givePiece(PieceType type,
                      int amount)
               throws ModelException
```
    Parameters:
    
    type -
    
    amount -
    
    Throws:
    
    ModelException - if type robber passed in or if try to give negative amount
  - giveDevCard
```
public void giveDevCard(DevCardType type)
```
    Gives the bank one dev card- it will be shuffled into pile
    
    Parameters:
    
    type -
  - giveDevCard
```
private void giveDevCard(DevCardType type,
                         int amount)
```
    Parameters:
    
    type -
    
    amount -
  - getResourceCount
```
public int getResourceCount()
```
    Gets the current number of all held resources
    
    Returns:
    
    the number of resources
  - getResourceCount
```
public int getResourceCount(ResourceType type)
```
    returns the number of resources for a specified type
    
    Parameters:
    
    type -
    
    Returns:
  - getPieceCount
```
public int getPieceCount(PieceType type)
                  throws ModelException
```
    Gets the number of pieces available for a type held
    
    Parameters:
    
    type -
    
    Returns:
    
    Throws:
    
    ModelException
  - getDevCardCount
```
public int getDevCardCount(DevCardType type)
```
    Gets the number of dev cards of a type held
    
    Parameters:
    
    type -
    
    Returns:
  - getArmyCount
```
public int getArmyCount()
```
    A little bit of a simple method but eh.
    
    Returns:
    
    the number of armys in the bank
  - getDevCardCount
```
public int getDevCardCount()
```
    Gets the total number of dev cards held
    
    Returns:
  - canBuildRoad
```
public boolean canBuildRoad()
```
    Checks if has enough cards to build a road (one wood, one brick, one road)
    
    Returns:
    
    true if allowed, false otherwise
  - buildRoad
```
public void buildRoad()
               throws ModelException
```
    Removes resource cards, if allowed, needed to build a road (one wood, one brick, one road)
    
    Throws:
    
    if - they don't have the resource
    
    ModelException
  - canBuildSettlement
```
public boolean canBuildSettlement()
```
    Checks if has enough cards to build a settlement (one wood, one brick, one sheep, one wheat, one settlement)
    
    Returns:
    
    true if allowed, false otherwise
  - buildSettlement
```
public void buildSettlement()
                     throws ModelException
```
    Removes resource cards, if allowed, needed to build a settlement (one wood, one brick, one sheep, one wheat, one settlement)
    
    Throws:
    
    if - they don't have the resource
    
    ModelException
  - canBuildCity
```
public boolean canBuildCity()
```
    Checks if has enough cards to build a city (two wheat, three ore, one city)
    
    Returns:
    
    true if allowed, false otherwise
  - buildCity
```
public boolean buildCity()
                  throws ModelException
```
    Removes resource cards, if allowed, needed to build a city (two wheat, three ore, one city)
    
    Throws:
    
    if - they don't have the resource
    
    ModelException
  - canBuyDevCard
```
public boolean canBuyDevCard()
```
    Checks if has enough cards to buy a development card (one wheat, one sheep, one ore)
    
    Returns:
    
    true if allowed, false otherwise
  - buyDevCard
```
public void buyDevCard()
                throws ModelException
```
    Removes resource cards, if allowed, needed to buy a development card (one wheat, one sheep, one ore)
    
    Throws:
    
    if - they don't have the resource
    
    ModelException
  - getNewDevCardCount
```
public int getNewDevCardCount(DevCardType type)
```
  - giveNewDevCard
```
public void giveNewDevCard(DevCardType type)
```
  - newToOldDevs
```
public void newToOldDevs()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - resourcesToString
```
public java.lang.String resourcesToString()
```
  - giveResourcesFor
```
public void giveResourcesFor(PieceType piece)
```
    Gives the bank the resources to buy this piece
    
    Parameters:
    
    piece -
  - giveResourcesForDevCard
```
public void giveResourcesForDevCard()
```
    Gives the bank the resources for a dev card

Class Bank

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

resources

devCards

pieces

numberResourceTypes

numberDevCardTypes

numberPieceTypes

solidersInPlay

newDevCards

Constructor Detail

Bank

Method Detail

resetToPlayerDefaults

resetToBankDefaults

getResource

getResource

getNumberSolidersRecruited

recruitSolider

getDevCard

getPiece

getDevCard

giveResource

giveResource

takeRandomResource

givePiece

givePiece

giveDevCard

giveDevCard

getResourceCount

getResourceCount

getPieceCount

getDevCardCount

getArmyCount

getDevCardCount

canBuildRoad

buildRoad

canBuildSettlement

buildSettlement

canBuildCity

buildCity

canBuyDevCard

buyDevCard

getNewDevCardCount

giveNewDevCard

newToOldDevs

hashCode

equals

toString

resourcesToString

giveResourcesFor

giveResourcesForDevCard