com.pi4j.device.fireplace

Interface Fireplace

All Superinterfaces:

Device, ObserveableDevice

All Known Implementing Classes:

FireplaceBase, FireplaceDevice

public interface Fireplace
extends ObserveableDevice

Method Summary

Modifier and Type	Method and Description
void	addListener(FireplacePilotLightListener... listener)
void	addListener(FireplaceStateChangeListener... listener)
void	addListener(FireplaceTimeoutListener... listener)
void	cancelTimeout()
FireplaceState	getState()
long	getTimeoutDelay()
TimeUnit	getTimeoutUnit()
boolean	isOff()
boolean	isOn()
boolean	isPilotLightOff()
boolean	isPilotLightOn()
boolean	isState(FireplaceState state)
void	off()
void	on()
void	on(long timeoutDelay, TimeUnit timeoutUnit)
void	removeListener(FireplacePilotLightListener... listener)
void	removeListener(FireplaceStateChangeListener... listener)
void	removeListener(FireplaceTimeoutListener... listener)
void	setState(FireplaceState state)
void	setTimeout(long delay, TimeUnit unit)
void	shutdown()

Methods inherited from interface com.pi4j.device.ObserveableDevice

removeAllListeners

Methods inherited from interface com.pi4j.device.Device

clearProperties, getName, getProperties, getProperty, getProperty, getTag, hasProperty, removeProperty, setName, setProperty, setTag

Method Detail

getState

FireplaceState getState()

setState

void setState(FireplaceState state)
       throws FireplacePilotLightException

Throws:

FireplacePilotLightException

isState

boolean isState(FireplaceState state)

isOn

boolean isOn()

isOff

boolean isOff()

isPilotLightOn

boolean isPilotLightOn()

isPilotLightOff

boolean isPilotLightOff()

on

void on()
 throws FireplacePilotLightException

Throws:

FireplacePilotLightException

on

void on(long timeoutDelay,
        TimeUnit timeoutUnit)
 throws FireplacePilotLightException

Throws:

FireplacePilotLightException

off

void off()

setTimeout

void setTimeout(long delay,
                TimeUnit unit)

cancelTimeout

void cancelTimeout()

getTimeoutDelay

long getTimeoutDelay()

getTimeoutUnit

TimeUnit getTimeoutUnit()

addListener

void addListener(FireplaceStateChangeListener... listener)

removeListener

void removeListener(FireplaceStateChangeListener... listener)

addListener

void addListener(FireplacePilotLightListener... listener)

removeListener

void removeListener(FireplacePilotLightListener... listener)

addListener

void addListener(FireplaceTimeoutListener... listener)

removeListener

void removeListener(FireplaceTimeoutListener... listener)

shutdown

void shutdown()