KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > avalon > excalibur > profile > ProfilePoint


1 /*
2  * Copyright (C) The Apache Software Foundation. All rights reserved.
3  *
4  * This software is published under the terms of the Apache Software License
5  * version 1.1, a copy of which has been included with this distribution in
6  * the LICENSE.txt file.
7  */
8 package org.apache.avalon.excalibur.profile;
9
10 /**
11  * The ProfilPoint interface is to mark objects that can be sampled by a
12  * Profiler. The interface only has one sampling method to simplify the items
13  * that can be sampled.
14  *
15  * @author <a HREF="mailto:bloritsch@apache.org">Berin Loritsch</a>
16  */
17 public interface ProfilePoint
18 {
19     /**
20      * Get the ProfilePoint's name. The Profiler uses this so that the
21      * heading for the sample data makes sense.
22      */
23     String JavaDoc getName();
24
25     /**
26      * Obtain the sample. All samples are an integer, so the profiled objects
27      * must measure quantity (numbers of items), rate (items/period), time in
28      * milliseconds, etc.
29      */
30     int getSample();
31 }
32
Popular Tags