forge/src/main/java/forge/card/CardCharacteristics.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;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;

import forge.CardColor;
import forge.card.replacement.ReplacementEffect;
import forge.card.spellability.AbilityMana;
import forge.card.spellability.SpellAbility;
import forge.card.staticability.StaticAbility;
import forge.card.trigger.Trigger;

/**
 * TODO: Write javadoc for this type.
 * 
 */
public class CardCharacteristics {
    private String name = "";
    private ArrayList<String> type = new ArrayList<String>();
    private CardManaCost manaCost = CardManaCost.EMPTY;
    private ArrayList<CardColor> cardColor = new ArrayList<CardColor>();
    private boolean cardColorsOverridden = false;
    private int baseAttack = 0;
    private int baseDefense = 0;
    private ArrayList<String> intrinsicKeyword = new ArrayList<String>();
    private ArrayList<SpellAbility> spellAbility = new ArrayList<SpellAbility>();
    private ArrayList<String> intrinsicAbility = new ArrayList<String>();
    private ArrayList<AbilityMana> manaAbility = new ArrayList<AbilityMana>();
    private ArrayList<Trigger> triggers = new ArrayList<Trigger>();
    private ArrayList<ReplacementEffect> replacementEffects = new ArrayList<ReplacementEffect>();
    private ArrayList<StaticAbility> staticAbilities = new ArrayList<StaticAbility>();
    private ArrayList<String> staticAbilityStrings = new ArrayList<String>();
    private String imageFilename = "";
    private String imageName = "";
    private ArrayList<EditionInfo> sets = new ArrayList<EditionInfo>();
    private Map<String, String> sVars = new TreeMap<String, String>();
    private String curSetCode = "";

    /**
     * Gets the name.
     * 
     * @return the name
     */
    public final String getName() {
        return this.name;
    }

    /**
     * Sets the name.
     * 
     * @param name0
     *            the name to set
     */
    public final void setName(final String name0) {
        this.name = name0;
    }

    /**
     * Gets the type.
     * 
     * @return the type
     */
    public final ArrayList<String> getType() {
        return this.type;
    }

    /**
     * Sets the type.
     * 
     * @param type0
     *            the type to set
     */
    public final void setType(final ArrayList<String> type0) {
        this.type = type0;
    }

    /**
     * Gets the mana cost.
     * 
     * @return the manaCost
     */
    public final CardManaCost getManaCost() {
        return this.manaCost;
    }

    /**
     * Sets the mana cost.
     * 
     * @param manaCost0
     *            the manaCost to set
     */
    public final void setManaCost(final CardManaCost manaCost0) {
        this.manaCost = manaCost0;
    }

    /**
     * Gets the card color.
     * 
     * @return the cardColor
     */
    public final ArrayList<CardColor> getCardColor() {
        return this.cardColor;
    }

    /**
     * Sets the card color.
     * 
     * @param cardColor0
     *            the cardColor to set
     */
    public final void setCardColor(final ArrayList<CardColor> cardColor0) {
        this.cardColor = new ArrayList<CardColor>(cardColor0);
    }

    /**
     * Checks if is card colors overridden.
     * 
     * @return the cardColorsOverridden
     */
    public final boolean isCardColorsOverridden() {
        return this.cardColorsOverridden;
    }

    /**
     * Sets the card colors overridden.
     * 
     * @param cardColorsOverridden0
     *            the cardColorsOverridden to set
     */
    public final void setCardColorsOverridden(final boolean cardColorsOverridden0) {
        this.cardColorsOverridden = cardColorsOverridden0;
    }

    /**
     * Gets the base attack.
     * 
     * @return the baseAttack
     */
    public final int getBaseAttack() {
        return this.baseAttack;
    }

    /**
     * Sets the base attack.
     * 
     * @param baseAttack0
     *            the baseAttack to set
     */
    public final void setBaseAttack(final int baseAttack0) {
        this.baseAttack = baseAttack0;
    }

    /**
     * Gets the base defense.
     * 
     * @return the baseDefense
     */
    public final int getBaseDefense() {
        return this.baseDefense;
    }

    /**
     * Sets the base defense.
     * 
     * @param baseDefense0
     *            the baseDefense to set
     */
    public final void setBaseDefense(final int baseDefense0) {
        this.baseDefense = baseDefense0;
    }

    /**
     * Gets the intrinsic keyword.
     * 
     * @return the intrinsicKeyword
     */
    public final ArrayList<String> getIntrinsicKeyword() {
        return this.intrinsicKeyword;
    }

    /**
     * Sets the intrinsic keyword.
     * 
     * @param intrinsicKeyword0
     *            the intrinsicKeyword to set
     */
    public final void setIntrinsicKeyword(final ArrayList<String> intrinsicKeyword0) {
        this.intrinsicKeyword = intrinsicKeyword0;
    }

    /**
     * Gets the spell ability.
     * 
     * @return the spellAbility
     */
    public final ArrayList<SpellAbility> getSpellAbility() {
        return this.spellAbility;
    }

    /**
     * Sets the spell ability.
     * 
     * @param spellAbility0
     *            the spellAbility to set
     */
    public final void setSpellAbility(final ArrayList<SpellAbility> spellAbility0) {
        this.spellAbility = spellAbility0;
    }

    /**
     * Gets the intrinsic ability.
     * 
     * @return the intrinsicAbility
     */
    public final ArrayList<String> getIntrinsicAbility() {
        return this.intrinsicAbility;
    }

    /**
     * Sets the intrinsic ability.
     * 
     * @param intrinsicAbility0
     *            the intrinsicAbility to set
     */
    public final void setIntrinsicAbility(final ArrayList<String> intrinsicAbility0) {
        this.intrinsicAbility = intrinsicAbility0;
    }

    /**
     * Gets the mana ability.
     * 
     * @return the manaAbility
     */
    public final ArrayList<AbilityMana> getManaAbility() {
        return this.manaAbility;
    }

    /**
     * Sets the mana ability.
     * 
     * @param manaAbility0
     *            the manaAbility to set
     */
    public final void setManaAbility(final ArrayList<AbilityMana> manaAbility0) {
        this.manaAbility = manaAbility0;
    }

    /**
     * Gets the triggers.
     * 
     * @return the triggers
     */
    public final List<Trigger> getTriggers() {
        return this.triggers;
    }

    /**
     * Sets the triggers.
     * 
     * @param triggers0
     *            the triggers to set
     */
    public final void setTriggers(final ArrayList<Trigger> triggers0) {
        this.triggers = triggers0;
    }

    /**
     * Gets the static abilities.
     * 
     * @return the staticAbilities
     */
    public final ArrayList<StaticAbility> getStaticAbilities() {
        return this.staticAbilities;
    }

    /**
     * Sets the static abilities.
     * 
     * @param staticAbilities0
     *            the staticAbilities to set
     */
    public final void setStaticAbilities(final ArrayList<StaticAbility> staticAbilities0) {
        this.staticAbilities = new ArrayList<StaticAbility>(staticAbilities0);
    }

    /**
     * Gets the image filename.
     * 
     * @return the imageFilename
     */
    public final String getImageFilename() {
        return this.imageFilename;
    }

    /**
     * Sets the image filename.
     * 
     * @param imageFilename0
     *            the imageFilename to set
     */
    public final void setImageFilename(final String imageFilename0) {
        this.imageFilename = imageFilename0;
    }

    /**
     * Gets the sets.
     * 
     * @return the sets
     */
    public final ArrayList<EditionInfo> getSets() {
        return this.sets;
    }

    /**
     * Sets the sets.
     * 
     * @param sets0
     *            the sets to set
     */
    public final void setSets(final ArrayList<EditionInfo> sets0) {
        this.sets = new ArrayList<EditionInfo>(sets0);
        // name.
    }

    /**
     * Gets the static ability strings.
     * 
     * @return the staticAbilityStrings
     */
    public final ArrayList<String> getStaticAbilityStrings() {
        return this.staticAbilityStrings;
    }

    /**
     * Sets the static ability strings.
     * 
     * @param staticAbilityStrings0
     *            the staticAbilityStrings to set
     */
    public final void setStaticAbilityStrings(final ArrayList<String> staticAbilityStrings0) {
        this.staticAbilityStrings = staticAbilityStrings0;
    }

    /**
     * Gets the image name.
     * 
     * @return the imageName
     */
    public String getImageName() {
        return this.imageName;
    }

    /**
     * Sets the image name.
     * 
     * @param imageName0
     *            the imageName to set
     */
    public void setImageName(final String imageName0) {
        this.imageName = imageName0;
    }

    /**
     * @return the replacementEffects
     */
    public ArrayList<ReplacementEffect> getReplacementEffects() {
        return replacementEffects;
    }

    /**
     * @param replacementEffects0 the replacementEffects to set
     */
    public void setReplacementEffects(ArrayList<ReplacementEffect> replacementEffects0) {
        this.replacementEffects = replacementEffects0;
    }

    /**
     * <p>
     * getSVar.
     * </p>
     * 
     * @param var
     *            a {@link java.lang.String} object.
     * @return a {@link java.lang.String} object.
     */
    public final String getSVar(final String var) {
        if (this.sVars.containsKey(var)) {
            return this.sVars.get(var);
        } else {
            return "";
        }
    }

    /**
     * <p>
     * setSVar.
     * </p>
     * 
     * @param var
     *            a {@link java.lang.String} object.
     * @param str
     *            a {@link java.lang.String} object.
     */
    public final void setSVar(final String var, final String str) {
        this.sVars.put(var, str);
    }

    /**
     * <p>
     * getSVars.
     * </p>
     * 
     * @return a Map object.
     */
    public final Map<String, String> getSVars() {
        return this.sVars;
    }

    /**
     * <p>
     * setSVars.
     * </p>
     * 
     * @param newSVars
     *            a Map object.
     */
    public final void setSVars(final Map<String, String> newSVars) {
        this.sVars = newSVars;
    }

    /**
     * <p>
     * copy.
     * </p>
     * 
     * @param source
     *            a Map object.
     */
    public final void copy(final CardCharacteristics source) {
        // Makes a "deeper" copy of a CardCharacteristics object

        // String name : just copy reference
        this.name = source.getName();
        // ArrayList<String> type : list of String objects so use copy constructor
        this.type = new ArrayList<String>(source.getType());
        // CardManaCost manaCost : not sure if a deep copy is needed
        this.manaCost = source.getManaCost();
        // ArrayList<CardColor> cardColor : not sure if a deep copy is needed
        this.cardColor = new ArrayList<CardColor>(source.getCardColor());
        // boolean cardColorsOverridden : set value
        this.cardColorsOverridden = source.isCardColorsOverridden();
        // int baseAttack : set value
        this.baseAttack = source.getBaseAttack();
        // int baseDefense : set value
        this.baseDefense = source.getBaseDefense();
        // ArrayList<String> intrinsicKeyword : list of String objects so use copy constructor
        this.intrinsicKeyword =  new ArrayList<String>(source.getIntrinsicKeyword());
        // ArrayList<String> intrinsicAbility : list of String objects so use copy constructor
        this.intrinsicAbility = new ArrayList<String>(source.getIntrinsicAbility());
        // ArrayList<String> staticAbilityStrings : list of String objects so use copy constructor
        this.staticAbilityStrings = new ArrayList<String>(source.getStaticAbilityStrings());
        // String imageFilename = copy reference
        this.imageFilename = source.getImageFilename();
        // String imageName = "";
        this.imageName = source.getImageName();
        // ArrayList<EditionInfo> sets : deep copy not needed, just copy reference
        this.sets = source.getSets();
        // Map<String, String> sVars
        this.sVars = new TreeMap<String, String>(source.getSVars());
        // String curSetCode = "";
        this.curSetCode = source.getCurSetCode();
        
        this.replacementEffects = new ArrayList<ReplacementEffect>();
        for(ReplacementEffect RE : source.getReplacementEffects()) {
            this.replacementEffects.add(RE.getCopy());
        }
    }

    /**
     * @return the curSetCode
     */
    public String getCurSetCode() {
        return curSetCode;
    }

    /**
     * @param curSetCode0 the curSetCode to set
     */
    public void setCurSetCode(String curSetCode0) {
        this.curSetCode = curSetCode0;
    }
}