PolicyCard

java.lang.Object
- starvationevasion.common.PolicyCard

All Implemented Interfaces:

java.io.Serializable, JSON, Sendable

Direct Known Subclasses:

CleanRiverIncentivePolicy, CovertIntelligencePolicy, EducateTheWomenCampaignPolicy, EfficientIrrigationIncentivePolicy, EthanolTaxCreditChangePolicy, FertilizerSubsidyPolicy, ForeignAidFarmInfrastructureForMiddleEast, ForeignAidForFarmInfrastructurePolicy, GMOSeedInsectResistanceResearchPolicy, InternationalFoodReliefProgramPolicy, LoanPolicy, MyPlatePromotionCampaignPolicy
```
public abstract class PolicyCard
extends java.lang.Object
implements Sendable
```
PolicyCard is the structure used by the Client, Server and Simulator. It holds all the data needed by the Simulator to implement the effects of a a policy drafted and enacted by a player.

The game client's might want to extend this a class adding, for example, an image, a status (in deck, in hand, proposed, voting, enacted, rejected) and other data.

If the client does extend this class, DO NOT send the extended class to the Server. This will cause the transmission of unused data causing needed network lag. Rather, use the clone(PolicyCard source) method to create a new PolicyCard that will copy the parts of your extended policyCard that actually need to be sent.

Use the validate() method to verify all needed parameters of the policy are defined in range.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PolicyCard.EnumVariable

static class PolicyCard.EnumVariableUnit
- Nested classes/interfaces inherited from interface starvationevasion.server.io.JSON
  JSON.Parser

Nested Classes
Modifier and Type	Class and Description
`static class`	`PolicyCard.EnumVariable`
`static class`	`PolicyCard.EnumVariableUnit`

Field Summary

Fields
Modifier and Type Field and Description

static int MAX_MILLION_DOLLARS

static int MAX_PERCENT

static int MIN_MILLION_DOLLARS

static int MIN_PERCENT

Fields
Modifier and Type	Field and Description
`static int`	`MAX_MILLION_DOLLARS`
`static int`	`MAX_PERCENT`
`static int`	`MIN_MILLION_DOLLARS`
`static int`	`MIN_PERCENT`

Constructor Summary

Constructors
Constructor and Description

PolicyCard()

Constructors
Constructor and Description
`PolicyCard()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addEnactingRegion(EnumRegion region)` The Server is responsible for verifying and setting each enacting region of all policy cards requiring a vote (votesRequired() > 0). Each policy sent to the simulator must be enacted by at least one US region.
`void`	`clearVotes()` Clears all enacting regions.
`static PolicyCard`	`create(EnumRegion owner, EnumPolicy type)` This is a convenience method used to construct any of the many policy cards available in the game.
`boolean`	`didVoteYes(EnumRegion region)`
`boolean`	`equals(java.lang.Object o)`
`void`	`fromJSON(java.lang.Object doc)` Convert String into JSON
`EnumPolicy`	`getCardType()`
`int`	`getEnactingRegionCount()`
`abstract java.lang.String`	`getGameText()`
`java.util.ArrayList<java.lang.Integer>`	`getOptionsOfVariable()` The default is null (the given variable is not required).
`EnumRegion`	`getOwner()`
`java.lang.String`	`getPolicyName()`
`PolicyCard.EnumVariableUnit`	`getRequiredVariables(PolicyCard.EnumVariable variable)` The default is null (the given variable is not required).
`EnumFood`	`getTargetFood()` Some policy cards require a target food (crop or livestock).
`EnumRegion`	`getTargetRegion()` Some policy cards require a target region.
`abstract java.lang.String`	`getTitle()`
`java.lang.String`	`getType()`
`EnumFood[]`	`getValidTargetFoods()` The default is null (no target food required).
`EnumRegion`	`getValidTargetRegion()` The default is null (no target region required).
`EnumRegion[]`	`getValidTargetRegions()` The default is null (no target region required).
`int`	`getX()`
`int`	`getY()`
`int`	`getZ()`
`int`	`hashCode()`
`boolean`	`isEligibleToVote(EnumRegion playerRegion)` In the abstract Policy class, this method returns the default behavior of a policy card (isEligibleToVote() = false if the policy is automatic and true for any region if not automatic).
`void`	`setTargetFood(EnumFood targetFood)` Some policy cards require a target food (crop or livestock).
`void`	`setTargetRegion(EnumRegion region)` Some policy cards require a target region.
`void`	`setType(java.lang.String type)`
`void`	`setX(int x)`
`void`	`setY(int y)`
`void`	`setZ(int z)`
`JSONDocument`	`toJSON()` Convert class into json
`java.lang.String`	`toString()`
`java.lang.String`	`validate()` This method provides general validation checking of the policy card. Between the time when a PolicyCard is instantiated and drafted, it must have various fields set.
`int`	`votesRequired()` In the abstract Policy class, this method returns the default behavior of a policy card (votesRequired() = 0).
`boolean`	`voteWaitForAll()` In the abstract Policy class, this method returns the default behavior of a policy card (voteWaitForAll() = false).

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

- Field Detail
  - MIN_PERCENT
```
public static final int MIN_PERCENT
```
    See Also:
    
    Constant Field Values
  - MAX_PERCENT
```
public static final int MAX_PERCENT
```
    See Also:
    
    Constant Field Values
  - MIN_MILLION_DOLLARS
```
public static final int MIN_MILLION_DOLLARS
```
    See Also:
    
    Constant Field Values
  - MAX_MILLION_DOLLARS
```
public static final int MAX_MILLION_DOLLARS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PolicyCard
```
public PolicyCard()
```
- Method Detail
  - create
```
public static PolicyCard create(EnumRegion owner,
                                EnumPolicy type)
```
    This is a convenience method used to construct any of the many policy cards available in the game.
    
    Parameters:
    
    owner - US player region controlled by the player who drafts this policy.
    
    type - The policy card type to be constructed.
    
    Returns:
    
    new instance of a policy card.
  - getOwner
```
public EnumRegion getOwner()
```
    Returns:
    
    the owner of this policy card
  - getTitle
```
public abstract java.lang.String getTitle()
```
    Returns:
    
    The title text for this policy.
  - getGameText
```
public abstract java.lang.String getGameText()
```
    Returns:
    
    The game text for this policy.
  - votesRequired
```
public int votesRequired()
```
    In the abstract Policy class, this method returns the default behavior of a policy card (votesRequired() = 0). If a class extending Policy is not automatic, then it must override this method.
    
    Returns:
    
    0 if the policy is automatic. Otherwise, returns the number of votes required for the policy to be enacted.
    Note: This will always return a number that is no smaller than the number of regions returned by getRegionsEligibleToVote().
  - voteWaitForAll
```
public boolean voteWaitForAll()
```
    In the abstract Policy class, this method returns the default behavior of a policy card (voteWaitForAll() = false). If a class extending Policy is not automatic and requires waiting, then it must override this method.
    
    Returns:
    
    true if voting should continue until all eligible players have voted on this policy. Return false if voting should stop as soon as the required number of votes have been reached.
  - isEligibleToVote
```
public boolean isEligibleToVote(EnumRegion playerRegion)
```
    In the abstract Policy class, this method returns the default behavior of a policy card (isEligibleToVote() = false if the policy is automatic and true for any region if not automatic). If a class extending Policy requires different behavior, then it must override this method.
    
    Parameters:
    
    playerRegion - being queried.
    
    Returns:
    
    true if and only if the given playerRegion is eligible to vote on this particular policy
  - getCardType
```
public EnumPolicy getCardType()
```
    Returns:
    
    The policy card type for this policy.
  - getX
```
public int getX()
```
    Returns:
    
    the value of quantity X.
  - getY
```
public int getY()
```
    Returns:
    
    the value of quantity Y.
  - getZ
```
public int getZ()
```
    Returns:
    
    the value of quantity Z.
  - setX
```
public void setX(int x)
```
    Parameters:
    
    x - value to be set to quantity X.
  - setY
```
public void setY(int y)
```
    Parameters:
    
    y - value to be set to quantity Y.
  - setZ
```
public void setZ(int z)
```
    Parameters:
    
    z - value to be set to quantity Z.
  - setTargetRegion
```
public void setTargetRegion(EnumRegion region)
```
    Some policy cards require a target region.
    
    Parameters:
    
    region - Depending on the policy card, the given region will be required to be either a US region or a world region or perhaps some smaller subset of regions.
  - getTargetRegion
```
public EnumRegion getTargetRegion()
```
    Some policy cards require a target region.
    
    Returns:
    
    region Depending on the policy card, the target region will be either a US region or a world region.
  - setTargetFood
```
public void setTargetFood(EnumFood targetFood)
```
    Some policy cards require a target food (crop or livestock).
    
    Parameters:
    
    targetFood - sets the targetFood. Ignored if this policy does not use a target food.
  - getTargetFood
```
public EnumFood getTargetFood()
```
    Some policy cards require a target food (crop or livestock).
    
    Returns:
    
    targetFood.
  - clearVotes
```
public void clearVotes()
```
    Clears all enacting regions.
  - addEnactingRegion
```
public void addEnactingRegion(EnumRegion region)
```
    The Server is responsible for verifying and setting each enacting region of all policy cards requiring a vote (votesRequired() > 0).
    
    Each policy sent to the simulator must be enacted by at least one US region.
    
    Automatic policies are always and only enacted by the region who played the policy card.
    
    Some policy cards that require voting may be enacted by more than one region. In some cases, only the regions that voted for the policy enact it. In other cases (generally for international policies) either all US regions enact the policy or none do.
    
    Parameters:
    
    region - a United States region that will be enacting the policy.
  - didVoteYes
```
public boolean didVoteYes(EnumRegion region)
```
    Parameters:
    
    region - a United States region.
    
    Returns:
    
    true iff the given region voted to approve the policy.
  - getEnactingRegionCount
```
public int getEnactingRegionCount()
```
    Returns:
    
    Number of US regions who voted yes for this policy.
  - getValidTargetRegions
```
public EnumRegion[] getValidTargetRegions()
```
    The default is null (no target region required).
    
    Returns:
    
    An array of regions valid as the target region of this policyCard. Returns null if this card does not require a region.
  - getValidTargetRegion
```
public EnumRegion getValidTargetRegion()
```
    The default is null (no target region required).
    
    Returns:
    
    The regions valid as the target region of this policyCard. Returns null if this card does not require a region.
  - getValidTargetFoods
```
public EnumFood[] getValidTargetFoods()
```
    The default is null (no target food required).
    
    Returns:
    
    An array of food categories valid as the target food of this policyCard. Returns null if this card does not require a region.
  - getRequiredVariables
```
public PolicyCard.EnumVariableUnit getRequiredVariables(PolicyCard.EnumVariable variable)
```
    The default is null (the given variable is not required).
    
    Parameters:
    
    variable - to be queried.
    
    Returns:
    
    The units of the required variable or null if the given variable is not required.
  - getOptionsOfVariable
```
public java.util.ArrayList<java.lang.Integer> getOptionsOfVariable()
```
    The default is null (the given variable is not required).
    
    Returns:
    
    Gives the options of available prices/percentages that correspond to card
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getPolicyName
```
public java.lang.String getPolicyName()
```
  - validate
```
public java.lang.String validate()
```
    This method provides general validation checking of the policy card.
    
    Between the time when a PolicyCard is instantiated and drafted, it must have various fields set. Which fields must be set and the ranges of those fields is dependant on each particular subclass of PolicyCard.
    
    PolicyCard subclasses that need validation beyond what can be inferred from it's required fields should override this class, but open the override with super.validate(). Note: A policy that requires votes, may not have sufficient votes to be enacted, yet it may still be valid.
    
    The Server uses this method to validate policy cards sent by the client.
    Note: The client should never send the server invalid cards. If the simulator does find an error then either there is a bug in the client or the client has been hacked.
    
    After the Server validates a drafted policy card, if the policy requires voting, the Server must notify the client that the card is part of the voting phase. The Server must call didVoteYes(EnumRegion region) or each region that votes yes for the drafted policy.
    
    The Server must determine if a vote requiring policy is enacted and notify the clients.
    
    Additionally, at the end of the voting phase, the Server must tell the simulator which voting policies did not get enacted (by calling the simulator's discard(EnumRegion playerRegion, PolicyCard card) method.
    
    Returns:
    
    null if the policy is valid. Otherwise, returns an error message.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - toJSON
```
public JSONDocument toJSON()
```
    Description copied from interface: JSON
    
    Convert class into json
    
    Specified by:
    
    toJSON in interface JSON
    
    Returns:
    
    JSON representation of class
  - setType
```
public void setType(java.lang.String type)
```
    Specified by:
    
    setType in interface Sendable
  - getType
```
public java.lang.String getType()
```
    Specified by:
    
    getType in interface Sendable
  - fromJSON
```
public void fromJSON(java.lang.Object doc)
```
    Description copied from interface: JSON
    
    Convert String into JSON
    
    Specified by:
    
    fromJSON in interface JSON
    
    Parameters:
    
    doc - object to be converted

Class PolicyCard

Nested Class Summary

Nested classes/interfaces inherited from interface starvationevasion.server.io.JSON

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MIN_PERCENT

MAX_PERCENT

MIN_MILLION_DOLLARS

MAX_MILLION_DOLLARS

Constructor Detail

PolicyCard

Method Detail

create

getOwner

getTitle

getGameText

votesRequired

voteWaitForAll

isEligibleToVote

getCardType

getX

getY

getZ

setX

setY

setZ

setTargetRegion

getTargetRegion

setTargetFood

getTargetFood

clearVotes

addEnactingRegion

didVoteYes

getEnactingRegionCount

getValidTargetRegions

getValidTargetRegion

getValidTargetFoods

getRequiredVariables

getOptionsOfVariable

toString

getPolicyName

validate

hashCode

equals

toJSON

setType

getType

fromJSON