org.apache.avalon.excalibur.profile
Class PeekValueProfilePoint

java.lang.Object
  |
  +--org.apache.avalon.excalibur.profile.AbstractProfilePoint
        |
        +--org.apache.avalon.excalibur.profile.PeekValueProfilePoint

All Implemented Interfaces:

ProfilePoint

public class PeekValueProfilePoint

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

PeekValueProfilePoint(java.lang.String name)
Creates a PeekValueProfilePoint with an initial name.

Method Summary

int	getSample() Obtain the sample.
void	setValue(int currentValue) 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

PeekValueProfilePoint

public PeekValueProfilePoint(java.lang.String name)

Creates a PeekValueProfilePoint with an initial name.

Method Detail

setValue

public void setValue(int currentValue)

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.