com.pi4j.device.fireplace

Class FireplaceBase

java.lang.Object

com.pi4j.device.DeviceBase

com.pi4j.device.ObserveableDeviceBase

com.pi4j.device.fireplace.FireplaceBase

All Implemented Interfaces:

Device, Fireplace, ObserveableDevice

Direct Known Subclasses:

FireplaceDevice

public abstract class FireplaceBase
extends ObserveableDeviceBase
implements Fireplace

Field Summary

Fields

Modifier and Type	Field and Description
protected ScheduledExecutorService	executor
protected long	timeoutDelay
protected Future<?>	timeoutTask
protected TimeUnit	timeoutUnit

Fields inherited from class com.pi4j.device.ObserveableDeviceBase

listeners

Constructor Summary

Constructors

Constructor and Description
FireplaceBase()

Method Summary

Modifier and Type	Method and Description
void	addListener(FireplacePilotLightListener... listener)
void	addListener(FireplaceStateChangeListener... listener)
void	addListener(FireplaceTimeoutListener... listener)
void	cancelTimeout()
protected void	cancelTimeoutTask()
abstract FireplaceState	getState()
long	getTimeoutDelay()
TimeUnit	getTimeoutUnit()
boolean	isOff()
boolean	isOn()
boolean	isState(FireplaceState state)
protected void	notifyListeners(FireplacePilotLightEvent event)
protected void	notifyListeners(FireplaceStateChangeEvent event)
protected void	notifyListeners(FireplaceTimeoutEvent event)
void	off()
void	on()
void	on(long timeoutDelay, TimeUnit timeoutUnit)
void	removeListener(FireplacePilotLightListener... listener)
void	removeListener(FireplaceStateChangeListener... listener)
void	removeListener(FireplaceTimeoutListener... listener)
void	setTimeout(long delay, TimeUnit unit)
void	shutdown()

Methods inherited from class com.pi4j.device.ObserveableDeviceBase

addListener, removeAllListeners, removeListener

Methods inherited from class com.pi4j.device.DeviceBase

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.pi4j.device.fireplace.Fireplace

isPilotLightOff, isPilotLightOn, setState

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

Field Detail

timeoutDelay

protected long timeoutDelay

timeoutTask

protected Future<?> timeoutTask

timeoutUnit

protected TimeUnit timeoutUnit

executor

protected ScheduledExecutorService executor

Constructor Detail

FireplaceBase

public FireplaceBase()

Method Detail

isOn

public boolean isOn()

Specified by:

isOn in interface Fireplace

isOff

public boolean isOff()

Specified by:

isOff in interface Fireplace

getState

public abstract FireplaceState getState()

Specified by:

getState in interface Fireplace

isState

public boolean isState(FireplaceState state)

Specified by:

isState in interface Fireplace

addListener

public void addListener(FireplaceStateChangeListener... listener)

Specified by:

addListener in interface Fireplace

removeListener

public void removeListener(FireplaceStateChangeListener... listener)

Specified by:

removeListener in interface Fireplace

addListener

public void addListener(FireplacePilotLightListener... listener)

Specified by:

addListener in interface Fireplace

removeListener

public void removeListener(FireplacePilotLightListener... listener)

Specified by:

removeListener in interface Fireplace

addListener

public void addListener(FireplaceTimeoutListener... listener)

Specified by:

addListener in interface Fireplace

removeListener

public void removeListener(FireplaceTimeoutListener... listener)

Specified by:

removeListener in interface Fireplace

on

public void on()
        throws FireplacePilotLightException

Specified by:

on in interface Fireplace

Throws:

FireplacePilotLightException

off

public void off()

Specified by:

off in interface Fireplace

on

public void on(long timeoutDelay,
               TimeUnit timeoutUnit)
        throws FireplacePilotLightException

Specified by:

on in interface Fireplace

Throws:

FireplacePilotLightException

cancelTimeout

public void cancelTimeout()

Specified by:

cancelTimeout in interface Fireplace

setTimeout

public void setTimeout(long delay,
                       TimeUnit unit)

Specified by:

setTimeout in interface Fireplace

getTimeoutDelay

public long getTimeoutDelay()

Specified by:

getTimeoutDelay in interface Fireplace

getTimeoutUnit

public TimeUnit getTimeoutUnit()

Specified by:

getTimeoutUnit in interface Fireplace

notifyListeners

protected void notifyListeners(FireplaceStateChangeEvent event)

notifyListeners

protected void notifyListeners(FireplacePilotLightEvent event)

notifyListeners

protected void notifyListeners(FireplaceTimeoutEvent event)

cancelTimeoutTask

protected void cancelTimeoutTask()

shutdown

public void shutdown()

Specified by:

shutdown in interface Fireplace