plyimpl.java

一个用java编写的国际象棋小游戏

/*
  PlyImpl - A class to implement the functionality of one ply of 
            a chess game.

  Copyright (C) 2003 The Java-Chess team <[e-mail]>

  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 2
  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, write to the Free Software
  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
*/ 

package de.java_chess.javaChess.ply;

import de.java_chess.javaChess.position.*;


/**
 * This class implements the functionality of a ply.
 */
public class PlyImpl implements Ply {

    // Instance variables

    /**
     * The source of the ply.
     */
    Position _source;

    /**
     * The destination of the ply.
     */
    Position _destination;


    // Constructors

    /**
     * Construct a new ply from a source and a destination.
     *
     * @param source The source of the ply.
     * @param destination The destination of the ply.
     */
    public PlyImpl( Position source, Position destination) {
	setSource( source);
	setDestination( destination);
    }


    // Methods

    /**
     * Get the source of the ply.
     *
     * @return The source of the piece.
     */
    public final Position getSource() {
	return _source;
    }

    /**
     * Set the source of the ply.
     *
     * @param The new source of the piece.
     */
    public final void setSource( Position source) {
	_source = source;
    }

    /**
     * Get the destination of the piece.
     *
     * @return The destination of the piece.
     */
    public final Position getDestination() {
	return _destination;
    }

    /**
     * Set the destination of the piece.
     *
     * @param destination The new destination of the piece.
     */
    public final void setDestination( Position destination) {
	_destination = destination;
    }

    /**
     * Convert the ply into something human readable. It's not exactly chess
     * notation, since we don't have a board to check, if it is a move or
     * a attack.
     *
     * @return The ply as a string.
     */
    public String toString() {
	return getSource().toSquareName() + "-" + getDestination().toSquareName();
    }

    /**
     * Test, if this ply is equal to another ply.
     *
     * @param ply The other ply.
     *
     * @return true, if the 2 plies are equal.
     */
    public final boolean equals( Ply ply) {
	return ply.getSource().equals( getSource())
	    && ply.getDestination().equals( getDestination());
    }
}