edu.umd.cs.findbugs.log

Class Profiler

java.lang.Object

edu.umd.cs.findbugs.log.Profiler

All Implemented Interfaces:

XMLWriteable

public class Profiler
extends java.lang.Object
implements XMLWriteable

Author:

pugh

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Profiler.ClassNameComparator
static interface	Profiler.Filter
static class	Profiler.FilterByCalls
static class	Profiler.FilterByTime
static class	Profiler.FilterByTimePerCall
static class	Profiler.Profile
static class	Profiler.TimePerCallComparator
static class	Profiler.TotalCallsComparator
static class	Profiler.TotalTimeComparator

Constructor Summary

Constructors

Constructor and Description
Profiler()

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clears the previously accumulated data.
void	end(java.lang.Class<?> c)
void	endContext(java.lang.Object context)
Profiler.Profile	getProfile(java.lang.Class<?> c)
void	report() Default implementation uses Profiler.TotalTimeComparator and prints out class statistics based on total time spent fot a class
void	report(java.util.Comparator<java.lang.Class<?>> reportComparator, Profiler.Filter filter, java.io.PrintStream stream)
void	start(java.lang.Class<?> c)
void	startContext(java.lang.Object context)
void	writeXML(XMLOutput xmlOutput) Write this object to given XMLOutput.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Profiler

public Profiler()

Method Detail

startContext

public void startContext(java.lang.Object context)

endContext

public void endContext(java.lang.Object context)

start

public void start(java.lang.Class<?> c)

end

public void end(java.lang.Class<?> c)

report

public void report()

Default implementation uses Profiler.TotalTimeComparator and prints out class statistics based on total time spent fot a class

report

public void report(java.util.Comparator<java.lang.Class<?>> reportComparator,
          Profiler.Filter filter,
          java.io.PrintStream stream)

Parameters:

reportComparator - non null comparator instance which will be used to sort the report statistics

clear

public void clear()

Clears the previously accumulated data. This method is public because it can be accessed explicitely from clients (like Eclipse).

There is no need to clear profiler data after each run, because a new profiler instance is used for each analysis run (see FindBugs2.execute()).

getProfile

public Profiler.Profile getProfile(java.lang.Class<?> c)

writeXML

public void writeXML(XMLOutput xmlOutput)
              throws java.io.IOException

Description copied from interface: XMLWriteable

Write this object to given XMLOutput.

Specified by:

writeXML in interface XMLWriteable

Parameters:

xmlOutput - the XMLOutput for the document

Throws:

java.io.IOException