AbstractDelegate.java

package games.strategy.triplea.delegate;

import java.io.Serializable;

import games.strategy.engine.data.GameData;
import games.strategy.engine.data.PlayerID;
import games.strategy.engine.delegate.IDelegate;
import games.strategy.engine.delegate.IDelegateBridge;
import games.strategy.engine.display.IDisplay;
import games.strategy.engine.gamePlayer.IRemotePlayer;
import games.strategy.engine.message.IRemote;
import games.strategy.sound.ISound;

/**
 * Base class designed to make writing custom delegates simpler.
 * Code common to all delegates is implemented here.
 */
public abstract class AbstractDelegate implements IDelegate {
  protected String m_name;
  protected String m_displayName;
  protected PlayerID m_player;
  protected IDelegateBridge m_bridge;

  /**
   * Creates a new instance of the Delegate.
   */
  public AbstractDelegate() {}

  @Override
  public void initialize(final String name, final String displayName) {
    m_name = name;
    m_displayName = displayName;
  }

  /**
   * Called before the delegate will run, AND before "start" is called.
   */
  @Override
  public void setDelegateBridgeAndPlayer(final IDelegateBridge iDelegateBridge) {
    m_bridge = iDelegateBridge;
    m_player = iDelegateBridge.getPlayerID();
  }

  /**
   * Called before the delegate will run.
   * All classes should call super.start if they override this.
   */
  @Override
  public void start() {
    // nothing to do here
  }

  /**
   * Called before the delegate will stop running.
   * All classes should call super.end if they override this.
   */
  @Override
  public void end() {
    // nothing to do here
  }

  @Override
  public String getName() {
    return m_name;
  }

  @Override
  public String getDisplayName() {
    return m_displayName;
  }

  /**
   * Returns the state of the Delegate.
   * All classes should super.saveState if they override this.
   */
  @Override
  public Serializable saveState() {
    return null;
  }

  /**
   * Loads the delegate state.
   */
  @Override
  public void loadState(final Serializable state) {
    // nothing to save
  }

  /**
   * If this class implements an interface which inherits from IRemote, returns the class of that interface.
   * Otherwise, returns null.
   */
  @Override
  public abstract Class<? extends IRemote> getRemoteType();

  @Override
  public IDelegateBridge getBridge() {
    return m_bridge;
  }

  protected GameData getData() {
    return m_bridge.getData();
  }

  protected IDisplay getDisplay() {
    return getDisplay(m_bridge);
  }

  protected static IDisplay getDisplay(final IDelegateBridge bridge) {
    return bridge.getDisplayChannelBroadcaster();
  }

  protected ISound getSoundChannel() {
    return getSoundChannel(m_bridge);
  }

  protected static ISound getSoundChannel(final IDelegateBridge bridge) {
    return bridge.getSoundChannelBroadcaster();
  }

  protected IRemotePlayer getRemotePlayer() {
    return getRemotePlayer(m_bridge);
  }

  protected static IRemotePlayer getRemotePlayer(final IDelegateBridge bridge) {
    return bridge.getRemotePlayer();
  }

  /**
   * You should override this class with some variation of the following code (changing the AI to be something
   * meaningful if needed)
   * because otherwise an "isNull" (ie: the static "Neutral" player) will not have any remote:
   * <p>
   * if (player.isNull()) {
   * return new WeakAI(player.getName(), TripleA.WEAK_COMPUTER_PLAYER_TYPE);
   * }
   * return bridge.getRemotePlayer(player);
   * </p>
   */
  protected IRemotePlayer getRemotePlayer(final PlayerID player) {
    return m_bridge.getRemotePlayer(player);
  }
}
/*
 * All overriding classes should use the following format for saveState and loadState, in order to save and load the
 * superstate
 * class ExtendedDelegateState implements Serializable
 * {
 * Serializable superState;
 * // add other variables here:
 * }
 *
 * @Override
 * public Serializable saveState()
 * {
 * ExtendedDelegateState state = new ExtendedDelegateState();
 * state.superState = super.saveState();
 * // add other variables to state here:
 * return state;
 * }
 *
 * @Override
 * public void loadState(Serializable state)
 * {
 * ExtendedDelegateState s = (ExtendedDelegateState) state;
 * super.loadState(s.superState);
 * // load other variables from state here:
 * }
 */