gamereportevent.java

MegaMek is a networked Java clone of BattleTech, a turn-based sci-fi boardgame for 2+ players. Fight

/*
 * MegaMek - Copyright (C) 2005 Ben Mazur ([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.
 */

package megamek.common.event;

/**
 * Normally, reports are dealt with during report phases.  When a report is
 * sent at an odd time though, an instance of this class is sent.
 */
public class GameReportEvent extends GameEvent {

    private String report;

    /**
     * Create a new Report event.
     * 
     * @param source the Object that generated this report
     * @param s a String of the report
     */
    public GameReportEvent(Object source, String s) {
        super(source, GAME_REPORT);
        this.report = s;
    }

    /**
     * Get the text of the report associated with this event.
     *
     * @return a String of the report
     */
    public String getReport() {
        return this.report;
    }
}