com.screenscraper.profiling

Class ObjectMemoryProfile

java.lang.Object

com.screenscraper.profiling.ObjectMemoryProfile

public class ObjectMemoryProfile
extends java.lang.Object

Class that represents a profiled object. Internally, this also handles the actual profiling, but should only be created by the profiler 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

Modifier	Constructor and Description
protected	ObjectMemoryProfile(ProfilingFilter globalFilter, java.util.Map<java.lang.Class,ProfilingFilter> filterMap, boolean buildChildRelations) Sets up the profile

Method Summary

Modifier and Type	Method and Description
void	dumpToXML(java.lang.String file) Dumps the information to an XML file.
long	getBytesUsed() Returns the total number of bytes of the root object given
java.util.Map<java.lang.Class,com.screenscraper.profiling.ObjectMemoryProfile.ProfileClassDetail>	getProfileClassDetails() Returns a copy of the map of details for the classes discovered during the profiling process
java.util.List<com.screenscraper.profiling.ObjectMemoryProfile.ProfileClassDetail>	getSortedProfileClassDetails() Returns a sorted list of details for the classes discovered during profiling.
java.util.List<TrackedObject>	getTrackedObjects(boolean sortByTotalBytes) Returns a list of all objects discovered while building the profile
protected void	profileObject(java.lang.Object object) Method called to profile an object.
void	setSortMethod(ProfileSort sortMethod) Sets the sort method for class details
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

ObjectMemoryProfile

protected ObjectMemoryProfile(@NotNull
                              ProfilingFilter globalFilter,
                              @Nullable
                              java.util.Map<java.lang.Class,ProfilingFilter> filterMap,
                              boolean buildChildRelations)

Sets up the profile

Method Detail

getBytesUsed

public long getBytesUsed()

Returns the total number of bytes of the root object given

Returns:

The number of bytes used by the main object

getProfileClassDetails

@NotNull
public java.util.Map<java.lang.Class,com.screenscraper.profiling.ObjectMemoryProfile.ProfileClassDetail> getProfileClassDetails()

Returns a copy of the map of details for the classes discovered during the profiling process

Returns:

A copy of the map of details for the classes discovered during the profiling process

getSortedProfileClassDetails

@NotNull
public java.util.List<com.screenscraper.profiling.ObjectMemoryProfile.ProfileClassDetail> getSortedProfileClassDetails()

Returns a sorted list of details for the classes discovered during profiling. Sort order is based on the ProfileSort used by this object

Returns:

The sorted list of class details

getTrackedObjects

@NotNull
public java.util.List<TrackedObject> getTrackedObjects(boolean sortByTotalBytes)

Returns a list of all objects discovered while building the profile

Parameters:

sortByTotalBytes - True to sort by total bytes used by the object, false to sort based on the shallow size of the object

Returns:

A sorted list of all objects discovered by the profiling process

profileObject

protected void profileObject(@NotNull
                             java.lang.Object object)

Method called to profile an object. This should only be called by the profiler

Parameters:

object - The object to profile

toString

@NotNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setSortMethod

public void setSortMethod(ProfileSort sortMethod)

Sets the sort method for class details

Parameters:

sortMethod - Sets the type of sorting that should be used for details from the profile. These can be class name, bytes used, etc...

dumpToXML

public void dumpToXML(@NotNull
                      java.lang.String file)

Dumps the information to an XML file. Note that this only works if the profiler was set to build the children relations

Parameters:

file - The name of the file to dump the profiling details to