com.jamonapi
Interface MinimalMonitor

All Known Subinterfaces:
AccumulateMonitorInterface
All Known Implementing Classes:
AccumulateMonitor, Monitor, MonitorComposite, NullAccumulateMonitor

public interface MinimalMonitor

Most basic interfaces that all monitors must implement. Right now the only type of Monitors are timing related monitors, but the interface is generic that future types may be added. For example it would be easy to add a Monitor that could track the number of bytes sent to a client browser or something similar.


Method Summary
 long getAccrued()
          Return the accrued value.
 void getData(java.util.ArrayList rowData)
          Add this elements value to the ArrayList.
 void getHeader(java.util.ArrayList header)
          Add this elements header value to an ArrayList.
 void increase(long increaseValue)
          Increase the monitors value
 void reset()
          Erase the values in the monitor
 

Method Detail

getAccrued

public long getAccrued()
Return the accrued value. In the case of timing monitors this would be the elapsed time since the timer started


increase

public void increase(long increaseValue)
Increase the monitors value


reset

public void reset()
Erase the values in the monitor


getData

public void getData(java.util.ArrayList rowData)
Add this elements value to the ArrayList. This is used to display the Monitor in a tabular format.


getHeader

public void getHeader(java.util.ArrayList header)
Add this elements header value to an ArrayList. This is used to display the Monitor in a tabular format.