OptionNotifier.java

package gnu.dtools.ritopt;

/**
 * If an object is able notify and maintain a repository of listeners, it
 * should implement this interface even though it is not required. This
 * interface expects listener registration and event configuration behavior.
 *
 * <hr>
 *
 * <pre>
 * Copyright (C) Damian Ryan Eads, 2001. All Rights Reserved.
 *
 * ritopt 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.

 * ritopt 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 ritopt; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 * </pre>
 *
 * @author Damian Eads
 */

public interface OptionNotifier {

    /**
     * Adds an OptionListener to the notification list.
     *
     * @param listener The OptionListener to add.
     */

    public void addOptionListener( OptionListener listener );

    /**
     * Removes an OptionListener from the notification list.
     *
     * @param listener The OptionListener to remove.
     */

    public void removeOptionListener( OptionListener listener );

    /**
     * Sets the command sent when an option is invoked.
     *
     * @param command  The command to send.
     */

    public void setOptionCommand( String command );

}