12.4. Histories
The set of
Statistics objects for a particular metric during a Window is called the history of the metric, which is represented by the org.modeshape.jcr.api.monitor.History interface:
public interface History {
/**
* Get the kind of window.
*
* @return the window type; never null
*/
public Window getWindow();
/**
* Get the total duration of this history window.
*
* @param unit the desired time unit; if null, then {@link TimeUnit#SECONDS} is used
* @return the duration
*/
public long getTotalDuration( TimeUnit unit );
/**
* Get the timestamp (including time zone information) at which this history window starts.
*
* @return the time at which this window starts
*/
public DateTime getStartTime();
/**
* Get the timestamp (including time zone information) at which this history window ends.
*
* @return the time at which this window ends
*/
public DateTime getEndTime();
/**
* Get the statistics for that make up the history.
*
* @return the statistics; never null, but the array may contain null if the window is
* longer than the lifetime of the repository
*/
Statistics[] getStats();
}
Note
The
org.modeshape.jcr.api.value.DateTime interface is an immutable representation of an instant in time. It includes timezone information and methods for converting or obtaining the various representations and/or parts of the instant. It is based upon initial work by the JSR-310 effort, and is far superior to the mutable and difficult-to-use java.util.Calendar class.