forge/src/main/java/forge/card/mana/ManaPaid.java

/*
 * Forge: Play Magic: the Gathering.
 * Copyright (C) 2011  Forge Team
 *
 * This program 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 3 of the License, or
 * (at your option) any later version.
 * 
 * This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package forge.card.mana;

import forge.Card;
import forge.Constant;
import forge.control.input.InputPayManaCostUtil;

/**
 * <p>
 * Mana class.
 * </p>
 * 
 * @author Forge
 * @version $Id$
 */
public class ManaPaid {
    private String color;
    private int amount = 0;
    private Card sourceCard = null;

    /**
     * <p>
     * Constructor for Mana.
     * </p>
     * 
     * @param col
     *            a {@link java.lang.String} object.
     * @param amt
     *            a int.
     * @param source
     *            a {@link forge.Card} object.
     */
    public ManaPaid(final String col, final int amt, final Card source) {
        this.color = col;
        this.amount = amt;
        if (source == null) {
            return;
        }

        this.sourceCard = source;
    }

    /**
     * <p>
     * toString.
     * </p>
     * 
     * @return a {@link java.lang.String} object.
     */
    @Override
    public final String toString() {
        if (this.color.equals(Constant.Color.COLORLESS)) {
            return Integer.toString(this.amount);
        }

        String manaString = "";
        final StringBuilder sbMana = new StringBuilder();

        manaString = InputPayManaCostUtil.getShortColorString(this.color);

        for (int i = 0; i < this.amount; i++) {
            sbMana.append(manaString);
        }
        return sbMana.toString();
    }

    /**
     * <p>
     * toDescriptiveString.
     * </p>
     * 
     * @return a {@link java.lang.String} object.
     */
    public final String toDescriptiveString() {
        // this will be used for advanced choice box
        if (this.color.equals(Constant.Color.COLORLESS)) {
            return Integer.toString(this.amount);
        }

        String manaString = "";
        final StringBuilder sbMana = new StringBuilder();

        manaString = InputPayManaCostUtil.getShortColorString(this.color);

        for (int i = 0; i < this.amount; i++) {
            sbMana.append(manaString);
        }

        if (this.isSnow()) {
            sbMana.append("(S)");
        }

        sbMana.append(" From ");
        sbMana.append(this.sourceCard.getName());

        return sbMana.toString();
    }

    /**
     * <p>
     * toSingleArray.
     * </p>
     * 
     * @return an array of {@link forge.card.mana.ManaPaid} objects.
     */
    public final ManaPaid[] toSingleArray() {
        final ManaPaid[] normalize = new ManaPaid[this.amount];
        for (int i = 0; i < normalize.length; i++) {
            normalize[i] = new ManaPaid(this.color, 1, this.sourceCard);
        }
        return normalize;
    }

    /**
     * <p>
     * isSnow.
     * </p>
     * 
     * @return a boolean.
     */
    public final boolean isSnow() {
        return this.sourceCard.isSnow();
    }

    /**
     * <p>
     * fromBasicLand.
     * </p>
     * 
     * @return a boolean.
     */
    public final boolean fromBasicLand() {
        return this.sourceCard.isBasicLand();
    } // for Imperiosaur

    /**
     * <p>
     * getColorlessAmount.
     * </p>
     * 
     * @return a int.
     */
    public final int getColorlessAmount() {
        return this.color.equals(Constant.Color.COLORLESS) ? this.amount : 0;
    }

    /**
     * <p>
     * Getter for the field <code>amount</code>.
     * </p>
     * 
     * @return a int.
     */
    public final int getAmount() {
        return this.amount;
    }

    /**
     * <p>
     * isColor.
     * </p>
     * 
     * @param col
     *            a {@link java.lang.String} object.
     * @return a boolean.
     */
    public final boolean isColor(final String col) {
        return this.color.equals(col);
    }

    /**
     * <p>
     * isColor.
     * </p>
     * 
     * @param colors
     *            an array of {@link java.lang.String} objects.
     * @return a boolean.
     */
    public final boolean isColor(final String[] colors) {
        for (final String col : colors) {
            if (this.color.equals(col)) {
                return true;
            }
        }

        return false;
    }

    /**
     * <p>
     * Getter for the field <code>color</code>.
     * </p>
     * 
     * @return a {@link java.lang.String} object.
     */
    public final String getColor() {
        return this.color;
    }

    /**
     * <p>
     * Getter for the field <code>sourceCard</code>.
     * </p>
     * 
     * @return a {@link forge.Card} object.
     */
    public final Card getSourceCard() {
        return this.sourceCard;
    }

    /**
     * <p>
     * fromSourceCard.
     * </p>
     * 
     * @param c
     *            a {@link forge.Card} object.
     * @return a boolean.
     */
    public final boolean fromSourceCard(final Card c) {
        return this.sourceCard.equals(c);
    }

    /**
     * <p>
     * decrementAmount.
     * </p>
     */
    public final void decrementAmount() {
        this.amount--;
    }

    /**
     * <p>
     * decrementAmount.
     * </p>
     * 
     * @param amountDecrement a int.
     */
    public void decrementAmount(final int amountDecrement) {
        this.amount -= amountDecrement;
    }
}