Package edu.umd.cs.findbugs.log

Class Profiler

java.lang.Object

edu.umd.cs.findbugs.log.Profiler

All Implemented Interfaces:

IProfiler, XMLWriteable

@NotThreadSafe
public class Profiler
extends java.lang.Object
implements IProfiler, XMLWriteable

This class is mutable and not synchronized, so create independent Profiler instance for each worker thread.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Profiler.ClassNameComparator
(package private) static class	Profiler.Clock
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

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.Stack<java.lang.Object>	context
(package private) static boolean	MAX_CONTEXT
private java.util.concurrent.ConcurrentMap<java.lang.Class<?>,Profiler.Profile>	profile	Using ConcurrentMap just for historical reason.
(package private) static boolean	REPORT
private java.util.Stack<Profiler.Clock>	startTimes

Constructor Summary

Constructors

Constructor	Description
Profiler()	The default constructor for Profiler.

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears the previously accumulated data.
(package private) boolean	contains(java.lang.Class<?> targetClass)
void	end(java.lang.Class<?> c)
void	endContext(java.lang.Object context)
private java.lang.Object	getContext()
Profiler.Profile	getProfile(java.lang.Class<?> c)
(package private) java.util.Collection<Profiler.Profile>	getProfiles()
(package private) java.util.Set<java.lang.Class<?>>	getTargetClasses()
void	report()	Deprecated. use ProfileSummary.report(java.util.Comparator<java.lang.Class<?>>, java.util.function.Predicate<edu.umd.cs.findbugs.log.Profiler.Profile>, java.io.PrintStream) instead.
void	report(java.util.Comparator<java.lang.Class<?>> reportComparator, Profiler.Filter filter, java.io.PrintStream stream)	Deprecated. use ProfileSummary.report(java.util.Comparator<java.lang.Class<?>>, java.util.function.Predicate<edu.umd.cs.findbugs.log.Profiler.Profile>, java.io.PrintStream) instead.
void	start(java.lang.Class<?> c)
void	startContext(java.lang.Object context)
void	writeXML(XMLOutput xmlOutput)	Deprecated. use ProfileSummary.writeXML(edu.umd.cs.findbugs.xml.XMLOutput) instead.

Methods inherited from class java.lang.Object

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

Field Detail

REPORT

static final boolean REPORT

MAX_CONTEXT

static final boolean MAX_CONTEXT

startTimes

private final java.util.Stack<Profiler.Clock> startTimes

context

private final java.util.Stack<java.lang.Object> context

profile

private final java.util.concurrent.ConcurrentMap<java.lang.Class<?>,Profiler.Profile> profile

Using ConcurrentMap just for historical reason. It can be Map because the Profiler class itself is not thread-safe.

Constructor Detail

Profiler

public Profiler()

The default constructor for Profiler.

Method Detail

startContext

public void startContext(java.lang.Object context)

endContext

public void endContext(java.lang.Object context)

getContext

private java.lang.Object getContext()

start

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

Parameters:

c - The class of detector, analyzer or others that is NOT shared among worker threads.

end

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

Parameters:

c - The class of detector, analyzer or others that is NOT shared among worker threads.

report

@Deprecated
public void report()

Deprecated.

use ProfileSummary.report(java.util.Comparator<java.lang.Class<?>>, java.util.function.Predicate<edu.umd.cs.findbugs.log.Profiler.Profile>, java.io.PrintStream) instead.

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

report

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

Deprecated.

use ProfileSummary.report(java.util.Comparator<java.lang.Class<?>>, java.util.function.Predicate<edu.umd.cs.findbugs.log.Profiler.Profile>, java.io.PrintStream) instead.

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 explicitly 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)

Specified by:

getProfile in interface IProfiler

writeXML

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

Deprecated.

use ProfileSummary.writeXML(edu.umd.cs.findbugs.xml.XMLOutput) instead.

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

getTargetClasses

@NonNull
java.util.Set<java.lang.Class<?>> getTargetClasses()

getProfiles

@NonNull
java.util.Collection<Profiler.Profile> getProfiles()

contains

@CheckReturnValue
boolean contains(@NonNull
                 java.lang.Class<?> targetClass)