PlayerStatusEnum.java

package edu.ntnu.idi.idatt.model.enums;

import java.math.BigDecimal;

import edu.ntnu.idi.idatt.model.player.Player;

/**
 * Enum class that holds the different player statuses.
 * 
 * @see Player
 */
public enum PlayerStatusEnum {
  ROARING_KITTY("Roaring Kitty", 50, new BigDecimal("8")),
  PAPER_HANDS("Paper Hands", 100, new BigDecimal("2")),
  SPECULATOR("Speculator", 20, new BigDecimal("2")),
  DIAMOND_HANDS("Diamond Hands", 10, new BigDecimal("3")),
  INVESTOR("Investor", 10, new BigDecimal("1.2")),
  NOVICE("Novice", 0, BigDecimal.ZERO);

  private final String title;
  private final int tradingWeeks;
  private final BigDecimal ratio;

  /**
   * Constructor for PlayerStatusEnum
   * 
   * @param title        - Status name
   * @param tradingWeeks - How many weeks in trading to reach status.
   * @param ratio        - NetWorth/starting money
   */
  PlayerStatusEnum(String title, int tradingWeeks, BigDecimal ratio) {
    this.title = title;
    this.tradingWeeks = tradingWeeks;
    this.ratio = ratio;
  }

  /**
   * Getter for title.
   * 
   * @return String;
   */
  public String getTitle() {
    return title;
  }

  /**
   * Getter for trading weeks.
   * 
   * @return int;
   */
  public int getTradingWeeks() {
    return tradingWeeks;
  }

  /**
   * Getter for ratio.
   * 
   * @return BigDecimal.
   */
  public BigDecimal getRatio() {
    return ratio;
  }

}