OptionListener.java

package gnu.dtools.ritopt;

/**
 * OptionListener.java
 *
 * Version:
 *   $Id: OptionListener.java 322 2004-05-20 20:45:47Z mortenalver $
 */

/**
 * This interface is used to receive notification of option processing
 * events. Implementors are registered by being passed to an OptionNotifier's
 * addOptionListener method.
 *
 * Option processing events occur when an option is invoked at the command
 * line, menu, or is present in an options file.
 *
 * <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 OptionListener {

    /**
     * Invoked when an option processing event occurs. Option processing
     * events occur when an option is invoked at the command line, menu,
     * or is present in an options file.
     *
     * @param e   An object containing information about the option processing
     *            and invocation event.
     */

    public void optionInvoked( OptionEvent e );

} /** OptionListener **/