com.screenscraper.profiling

Class ObjectMemoryProfiler

java.lang.Object

com.screenscraper.profiling.ObjectMemoryProfiler

public class ObjectMemoryProfiler
extends java.lang.Object

Class used to determine the memory use of a specific object Author: Mike Date: 1/5/12 Time: 4:56 PM

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.log4j.Logger	LOGGER Used for logging.

Constructor Summary

Constructors

Constructor and Description
ObjectMemoryProfiler() Builds a profiler with a default filter that accepts everything
ObjectMemoryProfiler(ProfilingFilter filter) Builds a profiler that uses a given filter for it's global filter
ObjectMemoryProfiler(ProfilingFilter filter, boolean buildChildRelations) Builds a profiler that uses a given filter and optionally builds children relations into the profiled results

Method Summary

Modifier and Type	Method and Description
void	addFilter(java.lang.Class clazz, ProfilingFilter filter) Adds a filter to be used when a certain class is encountered
static ObjectMemoryProfiler	buildProfilerFromFiles(java.lang.String directory) Builds a profiler using profiles from a directory.
static ObjectMemoryProfiler	buildProfilerFromFiles(java.lang.String directory, boolean buildChildRelations) Builds a profiler using profiles from a directory.
ObjectMemoryProfile	deepMemoryUseOfObject(java.lang.Object object) Gets the deep memory use of an object.
boolean	getBuildChildRelations() Gets whether child relations will be built from this profiler's profiles or not
java.util.Map<java.lang.Class,ProfilingFilter>	getProfilingFilters() Returns a copy of the filters that this profiler will use
ObjectMemoryProfile	memoryUseOfObject(java.lang.Object object) Gets the shallow memory use of an object.
void	setBuildChildRelations(boolean buildChildRelations) Sets whether or not child relations will be built for future profiling from this object
void	setGlobalFilter(ProfilingFilter filter) Sets the global filter used by this profiler.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

protected static final org.apache.log4j.Logger LOGGER

Used for logging.

Constructor Detail

ObjectMemoryProfiler

public ObjectMemoryProfiler()

Builds a profiler with a default filter that accepts everything

ObjectMemoryProfiler

public ObjectMemoryProfiler(ProfilingFilter filter)

Builds a profiler that uses a given filter for it's global filter

Parameters:

filter - The filter to use as a global filter

ObjectMemoryProfiler

public ObjectMemoryProfiler(@Nullable
                            ProfilingFilter filter,
                            boolean buildChildRelations)

Builds a profiler that uses a given filter and optionally builds children relations into the profiled results

Parameters:

filter - The global filter to use

buildChildRelations - True to build child relations from this profiler (uses more memory), false otherwise. When true, a top-down view can be done, otherwise only a bottom-up view will be possible

Method Detail

setBuildChildRelations

public void setBuildChildRelations(boolean buildChildRelations)

Sets whether or not child relations will be built for future profiling from this object

Parameters:

buildChildRelations - True to build child relations, false otherwise. See the constructor for details

getBuildChildRelations

public boolean getBuildChildRelations()

Gets whether child relations will be built from this profiler's profiles or not

Returns:

True if child relations are to be built, false otherwise

addFilter

public void addFilter(java.lang.Class clazz,
                      ProfilingFilter filter)

Adds a filter to be used when a certain class is encountered

Parameters:

clazz - The class to set a filter for

filter - The filter to use for the given class

deepMemoryUseOfObject

@NotNull
public ObjectMemoryProfile deepMemoryUseOfObject(@NotNull
                                                           java.lang.Object object)

Gets the deep memory use of an object. This includes all the object's children, and their children, etc... unless a child is filtered out

Parameters:

object - The object to get the memory use of

Returns:

A profile for the given object

memoryUseOfObject

@NotNull
public ObjectMemoryProfile memoryUseOfObject(@NotNull
                                                       java.lang.Object object)

Gets the shallow memory use of an object. This excludes all the children of the object

Parameters:

object - The object to get memory use for

Returns:

The profile for the single object

getProfilingFilters

@NotNull
public java.util.Map<java.lang.Class,ProfilingFilter> getProfilingFilters()

Returns a copy of the filters that this profiler will use

Returns:

A copy of the filters used by this profiler

buildProfilerFromFiles

@NotNull
public static ObjectMemoryProfiler buildProfilerFromFiles(@NotNull
                                                                    java.lang.String directory)

Builds a profiler using profiles from a directory. Files should be named for the class they are to represent, such as "java.lang.String blacklist.filter" or "java.lang.String whitelist.filter"

In the case where both are found (a blacklist and whitelist file), the whitelist will be used. Note that the default filter should be in the file named "java.lang.Object listtype.filter" where listtype is either black or whitelist.

If no java.lang.Object filter type is given, anything that would use this filter uses the default WhitelistFilter with no whitelisted values

Parameters:

directory - The location of the directory containing the filters

Returns:

The new Profiler

buildProfilerFromFiles

@NotNull
public static ObjectMemoryProfiler buildProfilerFromFiles(@NotNull
                                                                    java.lang.String directory,
                                                                    boolean buildChildRelations)

Builds a profiler using profiles from a directory. Files should be named for the class they are to represent, such as "java.lang.String blacklist.filter" or "java.lang.String whitelist.filter"

In the case where both are found (a blacklist and whitelist file), the whitelist will be used. Note that the default filter should be in the file named "java.lang.Object listtype.filter" where listtype is either black or whitelist.

If no java.lang.Object filter type is given, anything that would use this filter uses the default WhitelistFilter with no whitelisted values

Parameters:

directory - The location of the directory containing the filters

buildChildRelations - True if child relations should be built when profiling from the newly created profiler

Returns:

The new Profiler

setGlobalFilter

public void setGlobalFilter(@Nullable
                            ProfilingFilter filter)

Sets the global filter used by this profiler.

Parameters:

filter - The filter to use globally. If an open filter is desired, use a blacklist filter with nothing set

toString

@NotNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object