org.apache.avalon.excalibur.profile
Interface ProfilePoint

All Known Implementing Classes:

AbstractProfilePoint

public interface ProfilePoint

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

Method Summary

java.lang.String	getName() Get the ProfilePoint's name.
int	getSample() Obtain the sample.

Method Detail

getName

public java.lang.String getName()

Get the ProfilePoint's name. The Profiler uses this so that the heading for the sample data makes sense.

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.