= Java Simon - Simple Monitors for Java =
Version: 4.0.0
This software is distributed under the terms of the The BSD 3-Clause License:
Check this readme online for updates: http://code.google.com/p/javasimon/wiki/Readme
For development and building see: http://code.google.com/p/javasimon/wiki/Development
== Getting started ==
Easiest way to start with Java Simon is adding Maven depndencies into your Maven project. See http://code.google.com/p/javasimon/wiki/MavenSupport for more.
A monitors in Java Simon is called "Simon". There are two types of Simons available: Counter and Stopwatch. Counter tracks single long value, its maximum and minimum. Stopwatch measures time and tracks number of measurements (splits), total time, split minimum and maximum, etc.
=== Simon Manager ===
You obtain Simons from the SimonManager:
{{{
Stopwatch stopwatch = SimonManager.getStopwatch("org.javasimon.examples.HelloWorld-stopwatch");
}}}
Here we obtained stopwatch Simon. If the Simon is accessed first time it is created. If you access existing Simon, type of the Simon must match - you can't create counter with the same name (unless you destroy the Simon first).
=== Stopwatch ===
Using stopwatch is simple: {{{ Split split = stopwatch.start(); // returns split object // here goes the measured code long time = split.stop(); // returns the split time in ns }}}
After few runs of your measured code you can get additional information from stopwatch: {{{ long totalNanos = stopwatch.getTotal(); long maxSplit = stopwatch.getMax(); long minSplit = stopwatch.getMin(); }}}
You can use convenient utility to print the results (note ns/us/ms/s unit after the number): {{{ System.out.println("Total time: " + SimonUtils.presentNanoTime(totalNanos)); }}}
Or simply print the Simon itself, it has nice toString output.
For more check other Resources (lower), you may head to GettingStarted wiki page: http://code.google.com/p/javasimon/wiki/GettingStarted
== Resources ==
Project is hosted on Google Code as "javasimon":
== Java Simon name ==
Java Simon is the official name of the project with Simple Monitoring API as a subtitle. Codename of the project is javasimon. We use word Simon as a synonym for a "monitor" in javadoc or on our wiki - of course we use it only for monitors based on the API. We write Simon mostly with capital S, Java Simon with space and javasimon as a one word with all lowercase. Word javasimon is probably best to use in search engines.