pcgen.gui2.facade.TempBonusFacadeImpl.java Source code

Java tutorial

Introduction

Here is the source code for pcgen.gui2.facade.TempBonusFacadeImpl.java

Source

/*
 * Copyright James Dempsey, 2012
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */
package pcgen.gui2.facade;

import java.text.Collator;
import java.util.List;

import org.apache.commons.lang3.StringUtils;

import pcgen.base.lang.StringUtil;
import pcgen.cdom.base.CDOMObject;
import pcgen.cdom.enumeration.ListKey;
import pcgen.cdom.enumeration.ObjectKey;
import pcgen.cdom.enumeration.SourceFormat;
import pcgen.cdom.enumeration.StringKey;
import pcgen.cdom.enumeration.Type;
import pcgen.cdom.inst.PCClassLevel;
import pcgen.core.Ability;
import pcgen.core.Equipment;
import pcgen.core.Globals;
import pcgen.core.PCClass;
import pcgen.core.PCTemplate;
import pcgen.core.Skill;
import pcgen.core.spell.Spell;
import pcgen.facade.core.TempBonusFacade;
import pcgen.system.LanguageBundle;
import pcgen.util.SortKeyAware;

/**
 * The Class {@code TempBonusFacadeImpl} a proxy for a TempBonus used for
 * displaying the temporary bonus on the UI. 
 *
 * 
 */

public class TempBonusFacadeImpl implements TempBonusFacade, Comparable<TempBonusFacadeImpl>, SortKeyAware {

    private final CDOMObject originObj;
    private boolean active;
    private final Object target;
    private final String bonusName;

    /**
     * Create a new instance of TempBonusFacadeImpl.
     * @param theOrigin The rules object that defines the bonus.  
     */
    TempBonusFacadeImpl(CDOMObject theOrigin) {
        this.originObj = theOrigin;
        this.active = true;
        this.target = null;
        this.bonusName = null;
    }

    /**
     * Create a new instance of TempBonusFacadeImpl for an applied bonus.
     * @param theOrigin The rules object that defines the bonus.  
     * @param theTarget The target object to which the bonus is applied.
     * @param bonusName The display name of the bonus (may include target information). 
     */
    TempBonusFacadeImpl(CDOMObject theOrigin, Object theTarget, String bonusName) {
        this.target = theTarget;
        this.bonusName = bonusName;
        this.originObj = theOrigin;
        this.active = true;
    }

    /**
     * Change the reported active state of this bonus.
     * @param newActive The new active state of the bonus.
     */
    void setActive(boolean newActive) {
        active = newActive;
    }

    @Override
    public String getSource() {
        return SourceFormat.getFormattedString(getOriginObj(), Globals.getSourceDisplay(), true);
    }

    @Override
    public String getSourceForNodeDisplay() {
        return SourceFormat.getFormattedString(getOriginObj(), SourceFormat.LONG, false);
    }

    @Override
    public String getKeyName() {
        return getOriginObj().getKeyName();
    }

    @Override
    public boolean isNamePI() {
        return getOriginObj().getSafe(ObjectKey.NAME_PI);
    }

    @Override
    public String getOriginType() {
        if (getOriginObj() instanceof Ability) {
            return LanguageBundle.getString("in_Ability"); //$NON-NLS-1$
        }
        if (getOriginObj() instanceof Equipment) {
            return LanguageBundle.getString("in_igEqModelColItem"); //$NON-NLS-1$
        }
        if (getOriginObj() instanceof Spell) {
            return LanguageBundle.getString("in_Spell"); //$NON-NLS-1$
        }
        if (getOriginObj() instanceof PCClass || getOriginObj() instanceof PCClassLevel) {
            return LanguageBundle.getString("in_classString"); //$NON-NLS-1$
        }
        if (getOriginObj() instanceof PCTemplate) {
            return LanguageBundle.getString("in_condition"); //$NON-NLS-1$
        }
        if (getOriginObj() instanceof Skill) {
            return LanguageBundle.getString("in_iskSkill"); //$NON-NLS-1$
        }
        return LanguageBundle.getString("in_itmRemBonButUnkownBonusType"); //$NON-NLS-1$
    }

    @Override
    public boolean isActive() {
        return active;
    }

    /**
     * @return the target
     */
    public Object getTarget() {
        return target;
    }

    @Override
    public int compareTo(TempBonusFacadeImpl o) {
        final Collator collator = Collator.getInstance();

        // Check sort keys first
        String key1 = this.getOriginObj().get(StringKey.SORT_KEY);
        if (key1 == null) {
            key1 = this.getOriginObj().getDisplayName();
        }
        String key2 = o.getOriginObj().get(StringKey.SORT_KEY);
        if (key2 == null) {
            key2 = o.getOriginObj().getDisplayName();
        }
        if (!key1.equals(key2)) {
            return collator.compare(key1, key2);
        }
        return collator.compare(this.getOriginObj().getDisplayName(), o.getOriginObj().getDisplayName());
    }

    @Override
    public String toString() {
        if (StringUtils.isNotEmpty(bonusName)) {
            return bonusName;
        }
        return getOriginObj().toString();
    }

    /**
     * @return the object defining the temporary bonus. 
     */
    public CDOMObject getOriginObj() {
        return originObj;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int result = 1;
        result = prime * result + ((originObj == null) ? 0 : originObj.hashCode());
        result = prime * result + ((target == null) ? 0 : target.hashCode());
        return result;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        TempBonusFacadeImpl other = (TempBonusFacadeImpl) obj;
        if (originObj == null) {
            if (other.originObj != null) {
                return false;
            }
        } else if (!originObj.equals(other.originObj)) {
            return false;
        }
        if (target == null) {
            if (other.target != null) {
                return false;
            }
        } else if (!target.equals(other.target)) {
            return false;
        }
        return true;
    }

    @Override
    public String getType() {
        final List<Type> types = originObj.getSafeListFor(ListKey.TYPE);
        return StringUtil.join(types, ".");
    }

    @Override
    public String getSortKey() {
        String sortKey = this.getOriginObj().get(StringKey.SORT_KEY);
        if (sortKey == null) {
            sortKey = this.getOriginObj().getDisplayName();
        }
        return sortKey;
    }
}