Developers guide

110
F.1.3. MasterswitchListener.java
/**
* $Id: MasterswitchListener.java,v 1.2 2002/10/22 08:23:11 oliverm Exp $
* Author: Oliver Mather
*
*/
package apt.masterswitch;
/**
* Description:
* <p>
* The listener interface for receiving Masterswitch Events.
* <p>
* @author $Author: oliverm $ <a href="mailto:[e-mail]">Oliver Mather</a>
* @version $Revision: 1.2 $
* @see apt.masterswitch.Masterswitch
*
*/
public interface MasterswitchListener {
/**
* The outlet has changed to newState
* <p>
* @param outlet The outlet number from 1 to {@link apt.masterswitch.Masterswitch#NUM_OUTLETS
NUM_OUTLETS}
* @param newState The new state of the specified outlet. This must be found in {@link
apt.masterswitch.Masterswitch#ALL_STATES ALL_STATES}
*/
public void outletStateChanged(int outlet, String newState);
/**
* The outlet has been renamed to newName
* <p>
* @param outlet The outlet number from 1 to {@link apt.masterswitch.Masterswitch#NUM_OUTLETS
NUM_OUTLETS}
* @param newName The new String label for the specified outlet
*/
public void outletNameChanged(int outlet, String newName);
/**
* Something has changed on the masterswitch, but we are not sure
* what. This event should typically be used to refresh the masterswitch
* status.
* <p>
*/
public void stateChanged();
}