org.apache.avalon.excalibur.profile
Class EventsPerSampleProfilePoint

java.lang.Object
  |
  +--org.apache.avalon.excalibur.profile.AbstractProfilePoint
        |
        +--org.apache.avalon.excalibur.profile.EventsPerSampleProfilePoint
All Implemented Interfaces:
ProfilePoint

public class EventsPerSampleProfilePoint
extends AbstractProfilePoint

The ProfilPoint interface is to mark objects that can be sampled by a Profiler. The interface only has one sampling method to simplify the items that can be sampled.

Author:
Berin Loritsch

Constructor Summary
EventsPerSampleProfilePoint(java.lang.String name)
          Creates a EventsPerSampleProfilePoint with an initial name.
 
Method Summary
 int getSample()
          Obtain the sample.
 void increment()
          Set the sample value
 
Methods inherited from class org.apache.avalon.excalibur.profile.AbstractProfilePoint
getName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EventsPerSampleProfilePoint

public EventsPerSampleProfilePoint(java.lang.String name)
Creates a EventsPerSampleProfilePoint with an initial name.
Method Detail

increment

public void increment()
Set the sample value

getSample

public int getSample()
Obtain the sample. All samples are an integer, so the profiled objects must measure quantity (numbers of items), rate (items/period), time in milliseconds, etc.


Copyright © 2001 Apache Jakarta Project. All Rights Reserved.