src

Class GenericClock

java.lang.Object

javax.swing.SwingWorker<java.lang.Integer,java.lang.String>

src.GenericClock

All Implemented Interfaces:

java.lang.Runnable, java.util.concurrent.Future<java.lang.Integer>, java.util.concurrent.RunnableFuture<java.lang.Integer>

Direct Known Subclasses:

EventClock

public class GenericClock
extends javax.swing.SwingWorker<java.lang.Integer,java.lang.String>

Clock element that controls events based on system time or internal counters. Root -generic- clock, containing basic operations shared by all kind of clock elements. It behaviour tries to imitate a real clock, iterating over its main loop every one second.

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.SwingWorker

javax.swing.SwingWorker.StateValue

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.lang.String	clockToPrint Textual representation of the time value -hour, minute and seconds-.
(package private) boolean	clockToPrintBlink Modifies the textual representation of the time value.
(package private) int	hour Clock time components.
(package private) javax.swing.JLabel	label GUI Label attached to the clock, used to represent time values.
(package private) int	minute Clock time components.
(package private) boolean	paused Behaviour control variable.
(package private) int	second Clock time components.
(package private) boolean	stopped Behaviour control variable.

Constructor Summary

Constructors

Constructor and Description
GenericClock() Default constructor.
GenericClock(int hour, int minute, int second, javax.swing.JLabel label) Creates Clock with initial time value and assigned GUI label.
GenericClock(javax.swing.JLabel label) Creates Clock that matchs the System Time.

Method Summary

Modifier and Type	Method and Description
protected java.lang.Integer	doInBackground() Core functionality of GenericClock.
void	pauseClock() Pauses clock.
protected java.lang.String	printClock() Prints time value in the attached label.
void	startClock() Starts clock.
void	stopClock() Stops the clock.
protected void	updateClock() Updates clock, increasing the second counter by one.

Methods inherited from class javax.swing.SwingWorker

addPropertyChangeListener, cancel, done, execute, firePropertyChange, get, get, getProgress, getPropertyChangeSupport, getState, isCancelled, isDone, process, publish, removePropertyChangeListener, run, setProgress

Methods inherited from class java.lang.Object

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

Field Detail

hour

int hour

Clock time components. Clock time values are represented by three componentes: - Seconds. - Minutes (1 minute = 60 seconds). - Hours (1 hour = 60 minutes). Time values are represented in digital format, being 00:00:00 the min. time value, and 23:59:59 the max. time value.

minute

int minute

Clock time components. Clock time values are represented by three componentes: - Seconds. - Minutes (1 minute = 60 seconds). - Hours (1 hour = 60 minutes). Time values are represented in digital format, being 00:00:00 the min. time value, and 23:59:59 the max. time value.

second

int second

Clock time components. Clock time values are represented by three componentes: - Seconds. - Minutes (1 minute = 60 seconds). - Hours (1 hour = 60 minutes). Time values are represented in digital format, being 00:00:00 the min. time value, and 23:59:59 the max. time value.

label

final javax.swing.JLabel label

GUI Label attached to the clock, used to represent time values.

paused

boolean paused

Behaviour control variable. Clock transits between "running/active", "paused" and "stopped" states. In each state, Clock executes a different set of operations. - Running: paused is FALSE, stopped is FALSE. - Paused: paused is TRUE, stopped is FALSE. - Stopped: stopped is TRUE (paused value is irrelevant). This variable indicates if clock is in 'paused' state.

stopped

boolean stopped

Behaviour control variable. Clock transits between "running/active", "paused" and "stopped" states. In each state, Clock executes a different set of operations. - Running: paused is FALSE, stopped is FALSE. - Paused: paused is TRUE, stopped is FALSE. - Stopped: stopped is TRUE (paused value is irrelevant). This variable indicates if clock is in 'stopped' state.

clockToPrint

java.lang.String clockToPrint

Textual representation of the time value -hour, minute and seconds-.

clockToPrintBlink

boolean clockToPrintBlink

Modifies the textual representation of the time value. It is used as a graphic effect trigger while clock is running: - When FALSE, colons are printed between the components 00:00:00 - When TRUE, colons are not printed between components 00 00 00

Constructor Detail

GenericClock

public GenericClock()

Default constructor. All variables are initialized to: - Zero. - Null. - False.

GenericClock

public GenericClock(int hour,
                    int minute,
                    int second,
                    javax.swing.JLabel label)

Creates Clock with initial time value and assigned GUI label. Time value is hour:minute:second (i.e: 12:20:34).

Parameters:

hour - hour value (min. value 0; max. value 23).

minute - minute value (min. value 0; max. value 59).

second - seconds value (min. value 0; max. value 59).

label - GUI label to be attached to the clock.

GenericClock

public GenericClock(javax.swing.JLabel label)

Creates Clock that matchs the System Time. Initial time value is equal to System Time of the local machine. It has attached a label too.

Parameters:

label - label to be attached to the clock.

Method Detail

doInBackground

protected java.lang.Integer doInBackground()
                                    throws java.lang.Exception

Core functionality of GenericClock. It implements the loop operations executed by the Clock.

Specified by:

doInBackground in class javax.swing.SwingWorker<java.lang.Integer,java.lang.String>

Returns:

time value.

Throws:

java.lang.Exception - SwingWorker exception.

See Also:

SwingWorker, SwingWorker.doInBackground()

updateClock

protected void updateClock()

Updates clock, increasing the second counter by one. Basic operation of GenericClock. It updates the time value by one second, working as a normal clock. When time value reachs its max. value, it returns to the min. value (hour in digital format). - Max. value: 23:59:59 - Min. value: 00:00:00

printClock

protected java.lang.String printClock()

Prints time value in the attached label. Time value is parsed to a String, in order to print it in the attached label. Blinking effect is performed. Each component -hour, minute, second - is printed in a two digit format. I.e: 03:20:21

Returns:

time value in String format.

pauseClock

public void pauseClock()

Pauses clock. Set 'paused' to True.

See Also:

paused

startClock

public void startClock()

Starts clock. Sets 'paused' and stopped to False.

See Also:

paused, stopped

stopClock

public void stopClock()

Stops the clock. Sets 'stoppe'd to True. 'pauseClock()' method is executed too for safety. Time value is restarted to zero.

See Also:

stopped, pauseClock()