/**
* Copyright (C) 2002-2012 The FreeCol Team
*
* This file is part of FreeCol.
*
* FreeCol is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* FreeCol is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with FreeCol. If not, see <http://www.gnu.org/licenses/>.
*/
package net.sf.freecol.common.model;
/**
* Represents a given turn in the game.
*/
public class Turn {
/**
* The season. Not distingished before 1600, then split into
* SPRING and AUTUMN.
*/
public static enum Season { YEAR, SPRING, AUTUMN }
/**
* The numerical value of the Turn, never less than one.
*/
private int turn = 1;
/**
* The year in which the game starts.
*/
private static int startingYear = 1492;
/**
* The first year in which there are two seasons.
*/
private static int seasonYear = 1600;
/**
* The first years of the "ages" of the game, which are only used
* for weighting {@link FoundingFather}s.
*/
private static int[] ages = new int[] {
1492, 1600, 1700
};
/**
* Creates a new <code>Turn</code> instance.
*
* @param turn The numeric value of the turn.
*/
public Turn(int turn) {
this.turn = turn;
}
/**
* Converts an integer year to a turn-integer-value.
* Allows for the season split.
*
* @param year A year.
* @return The integer value of the corresponding turn.
*/
public static int yearToTurn(int year) {
return yearToTurn(year, Season.YEAR);
}
/**
* Converts an integer year and specified season to a turn-integer-value.
*
* @param year an <code>int</code> value
* @param season a <code>Season</code> value
* @return The integer value of the corresponding turn.
*/
public static int yearToTurn(int year, Season season) {
int turn = 1;
if (year >= startingYear) {
turn += year - startingYear;
if (year >= seasonYear) {
turn += (year - seasonYear);
if (season == Season.AUTUMN) {
turn++;
}
}
}
return turn;
}
/**
* Increases the turn number by one.
*/
public Turn next() {
return new Turn(turn + 1);
}
/**
* Gets the turn number.
*
* @return The number of turns.
*/
public int getNumber() {
return turn;
}
/**
* Gets the age corresponding to the current turn.
*
* @return The age of this turn.
*/
public int getAge() {
return getAge(getYear());
}
/**
* Gets the age corresponding to a given turn.
*
* @param year The turn integer value.
* @return The age of this turn.
*/
public static int getAge(int year) {
for (int index = 0; index < ages.length; index++) {
if (year < ages[index]) {
return index;
}
}
return ages.length;
}
/**
* Gets the year this turn is in.
*
* @return The calculated year based on the turn number.
*/
public int getYear() {
return getYear(turn);
}
/**
* Gets the year the given turn is in.
*
* @return The calculated year based on the turn number.
*/
public static int getYear(int turn) {
int year = turn - 1 + startingYear;
return (year < seasonYear) ? year
: seasonYear + (year - seasonYear)/2;
}
/**
* Gets the Season of the given Turn number.
*
* @param turn The turn number to calculate from.
* @return The season corresponding to the turn number.
*/
public static Season getSeason(int turn) {
int year = turn - 1 + startingYear;
return (year < seasonYear) ? Season.YEAR
: (year % 2 == 0) ? Season.SPRING
: Season.AUTUMN;
}
/**
* Gets the Season of this Turn.
*
* @return a <code>Season</code> value
*/
public Season getSeason() {
return getSeason(turn);
}
/**
* Gets a localization template for this turn.
*
* @return A <code>StringTemplate</code> describing the turn.
*/
public StringTemplate getLabel() {
return getLabel(turn);
}
/**
* Gets a localization template for a given turn.
*
* @param turn The integer value of the turn to describe.
* @return A <code>StringTemplate</code> describing the turn.
*/
public static StringTemplate getLabel(int turn) {
return StringTemplate.template("year." + getSeason(turn))
.addAmount("%year%", getYear(turn));
}
/**
* Gets the starting year.
*
* @return The numeric value of the starting year.
*/
public static final int getStartingYear() {
return startingYear;
}
/**
* Sets the starting year.
*
* @param newStartingYear The new starting year value.
*/
public static final void setStartingYear(final int newStartingYear) {
startingYear = newStartingYear;
}
/**
* Gets the season year (the year the seasons split).
*
* @return The numeric value of the season year.
*/
public static final int getSeasonYear() {
return seasonYear;
}
/**
* Sets the season year.
*
* @param newSeasonYear The new season year value.
*/
public static final void setSeasonYear(final int newSeasonYear) {
seasonYear = newSeasonYear;
}
/**
* Is this turn the first one?
*
* @return True if this turn is the first turn.
*/
public boolean isFirstTurn() {
return turn == 1;
}
/**
* Is this turn the season year?
*
* @return True if this turn is the season year.
*/
public boolean isFirstSeasonTurn() {
return turn == yearToTurn(seasonYear, Season.SPRING);
}
/**
* Get the ages boundary array.
*
* @return The ages boundaries.
*/
public static final int[] getAges() {
return ages;
}
/**
* Sets the ages boundaries.
*
* @param newAges The new ages boundaries.
*/
public static final void setAges(final int[] newAges) {
ages = newAges;
}
/**
* Checks if this turn is equal to another turn.
*/
public boolean equals(Object o) {
return (o instanceof Turn) ? turn == ((Turn)o).turn : false;
}
/**
* Gets a string representation of this turn.
*
* @return A string with the format: "<i>[season] year</i>".
* Examples: "Spring 1602", "1503"...
*/
public String toString() {
return toString(turn);
}
/**
* Gets a non-localized string representation of the given turn.
*
* @return A string with the format: "<i>season year</i>".
* Examples: "SPRING 1602", "YEAR 1503"...
*/
public static String toString(int turn) {
return getSeason(turn).toString()
+ " " + Integer.toString(getYear(turn));
}
}