Package com.cleancode.data

This package provides facilities for extensible, configurable, on-the-fly diagnostics, settings, and data logging for standalone programs, CGI interaction, and client-level or server-level programs.

See:
Description

Class Summary

Diagnostic	Provides configurable diagnostic logging of several message types to several output channels.
Diagnostic.Test	A standalone test class to exercise the Diagnostic class.
InputOptions	Manages a collection of data inputs and configuration properties.
InputOptions.Test	A standalone test class to exercise the InputOptions class.
ParamMap	Manages a collection of parameters and their associated tool tips.
Version	Manages version numbers for all loaded classes.

Package com.cleancode.data Description

This package provides facilities for extensible, configurable, on-the-fly diagnostics, settings, and data logging for standalone programs, CGI interaction, and client-level or server-level programs.

Why use the Tracking package?

With this package, you can:

• Log errors and optionally warnings.
• Log diagnostics.
• Trace a program or trace a specific module.
• Use lots of debugging print statements but only get output from a specific subset of them.
• In CGI use, get output of debug statements on your generated web page.
• Switch a large range of program parameters between several different sets of values with just one input parameter (either command-line or CGI use).
• Get diagnostic/error output on multiple output channels.
• See version numbers of all Tracking-aware modules.
• Auto-format diagnostic display of structured data.
• Reuse the same code across platforms (Unix vs Windows and more...) or across languages (Perl, Java, and JavaScript).
• In CGI use, mix data parameters and configuration parameters.
• Establish system-wide properties available from any class.

Where to Go

The Diagnostic class provides detailed instructions for instrumenting your code to use diagnostics. The Settings class describes how to establish and use system-wide properties (akin to System.getProperty). The Log class explains how to create logs.

Multi-Lingual Library Initiative

This package supports the Multi-Lingual Library initiative, an endeavor which provides the same code libraries for different environments. My current languages of interest are Java, Perl, and JavaScript, so the same code could run on a client or a server; on Windows or Unix; in an applet, a CGI script, or a standalone program. See: Multi-Lingual Library for further details.

Maintainability Initiative

This package supports the Maintainability initiative, an endeavor which proscribes that designing test cases, flexible diagnostic controls, and testable code is an integral part of code design. See: Maintainability for further details.

Since:

V0