/*
* Copyright (c) Thomas Parker, 2009.
*
* This program 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 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 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.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
package pcgen.cdom.facet;
import pcgen.cdom.enumeration.CharID;
import pcgen.cdom.facet.base.AbstractSourcedListFacet;
import pcgen.cdom.facet.event.DataFacetChangeEvent;
import pcgen.cdom.facet.event.DataFacetChangeListener;
import pcgen.core.Equipment;
/**
* SourcedEquipmentFacet is a Facet that tracks the Equipment that is active on
* a PlayerCharacter. To be active, it must be Equipped, or a NaturalWeapon.
* This serves as a consolidation point for Equipment that is active on a Player
* Character.
*
* @author Thomas Parker (thpr [at] yahoo.com)
*/
public class SourcedEquipmentFacet extends AbstractSourcedListFacet<CharID, Equipment>
implements DataFacetChangeListener<CharID, Equipment>
{
/**
* Adds the active Equipment to this facet.
*
* Triggered when one of the Facets to which SourcedEquipmentFacet listens
* fires a DataFacetChangeEvent to indicate Equipment was added to a Player
* Character.
*
* @param dfce
* The DataFacetChangeEvent containing the information about the
* change
*
* @see pcgen.cdom.facet.event.DataFacetChangeListener#dataAdded(pcgen.cdom.facet.event.DataFacetChangeEvent)
*/
@Override
public void dataAdded(DataFacetChangeEvent<CharID, Equipment> dfce)
{
add(dfce.getCharID(), dfce.getCDOMObject(), dfce.getSource());
}
/**
* Removes the no-longer active Equipment from this facet.
*
* Triggered when one of the Facets to which SourcedEquipmentFacet listens
* fires a DataFacetChangeEvent to indicate Equipment was removed from a
* Player Character.
*
* @param dfce
* The DataFacetChangeEvent containing the information about the
* change
*
* @see pcgen.cdom.facet.event.DataFacetChangeListener#dataRemoved(pcgen.cdom.facet.event.DataFacetChangeEvent)
*/
@Override
public void dataRemoved(DataFacetChangeEvent<CharID, Equipment> dfce)
{
remove(dfce.getCharID(), dfce.getCDOMObject(), dfce.getSource());
}
}