WRLD.time - Class Documentation

Class Documentation how to use the WRLD.time classes in a safe & effective manner

once you've acquired the WRLD.time classes, the documentation below should help you leverage your chronological solution. it may also help to clarify some of the implementational / algorithmic questions that you've been asking yourself.

JavaDoc	full documentation for the Java package including some classes not listed below
WRLDtimeNow	command-line access to the WRLD.time chronometer
WRLDtimeApplet	the applet which drives a WRLDtimePiece
WRLDtimeApp	the command-line application which drives a WRLDtimePiece
WRLDtimePiece	an abstract class for creating a WRLDtimePiece
WRLDcron	the WRLD.time chronometer

Contents Previous Next WRLDtimeNow

A simple command-line app which returns the current WRLD.time.

Its WRLDcron chronometer is fully configurable via command-line options. For a full list of options, use '-help'. The application does not support the use of an external configuration file.

The current time is always returned in a format such as 'XX.XX'; the 2-digit measure, a period separator, then the 2-digit beat. The application will adapt the format to display the chronometer's maximum precision.

For more information, please see the JavaDoc for this class.

See also:
Config Files ... specifically the 'cron' configuration

Contents Previous Next WRLDtimeApplet

An applet that displays the current WRLD.time through a WRLDtimePiece.

This class drives the Applet componentry of a WRLDtimePiece. At the moment, this class can only create an instance of com.sleepbot.WRLDtime.time.WRLDtime. Some day it will be extended with a Factory process to create any WRLDtimePiece implementation... but not yet.

If you run the applet anywhere other than sleepbot.com, you get the WRLD.time logo -- a 25-pixel black bar at the bottom of the display region.

For more information, please see the JavaDoc for this class.

See also:
Attaching a Clock
Config Files

NOTE: The configuration described here is supported only by an instance of com.sleepbot.WRLDtime.time.WRLDtime. If you implement your own class, you'll need to support your own configuration methodology.

Contents Previous Next WRLDtimeApp

A command-line application that displays the current WRLD.time through a WRLDtimePiece.

It accepts one optimal parameter; an external conifiguration file. If not provided, a generic WRLD.time clock will be displayed (black-on-grey).

This class drives the Frame componentry of a WRLDtimePiece. At the moment, this class can only create an instance of com.sleepbot.WRLDtime.time.WRLDtime. Some day it will be extended with a Factory process to create any WRLDtimePiece implementation... but not yet.

For more information, please see the JavaDoc for this class.

See also:
On the Desktop
Config Files

NOTE: The configuration described here is supported only by an instance of com.sleepbot.WRLDtime.time.WRLDtime. If you implement your own class, you'll need to support your own configuration methodology.

Contents Previous Next WRLDtimePiece

An interface which defines everything you'll need to create a custom WRLDtime time-piece.

An implementing class can be used by both WRLDtimeApp and WRLDtimeApplet. Depending upon its owner's context, your time-piece will provide Frame or Applet functionality. In terms of time-keeping and rendering, they'll be largely similar.

The best example of how to provide such an implementation is the com.sleepbot.WRLDtime.time.WRLDtime class. There's also a no-op implementing class; com.sleepbot.WRLDtime.time.WRLDtimePieceNoOp.

For more information, please see the JavaDoc for this class.

See also:
JavaDoc for com.sleepbot.WRLDtime.time.WRLDtime
JavaDoc for com.sleepbot.WRLDtime.time.WRLDtimePieceNoOp

Contents Previous Next WRLDcron

The WRLD.time chronometer logic.

It's a generic class based on the idea of there being two components to any time code:

there's the beat -- which is the WRLD.time name for it; in a conventional clock, it's the minute. this is the faster, lighter component of the time code. its increment interval and cycle size is based upon your clock precision. at the end of each cycle, the beat gets incremented and the measure returns to 0.
there's the measure -- which is the WRLD.time name for it; in a conventional clock, it's the hour. this is the slower, heavier component of the time code. it is incremented once for every cycle of measures, and cycles back to 0 when the day ends.

For more information, please see the JavaDoc for this class.

See also:
JavaDoc for com.sleepbot.WRLDtime.cron.WRLDcronTick
Config Files

NOTE: The configuration described here is supported only by an instance of com.sleepbot.WRLDtime.time.WRLDtime. If you implement your own class, you'll need to support your own configuration methodology.

WRLD.time
a fine global temporal standard

Sleepbot Constructs