com.screenscraper.profiling

Class TrackedObject

java.lang.Object

com.screenscraper.profiling.TrackedObject

All Implemented Interfaces:

java.lang.Comparable<TrackedObject>

public class TrackedObject
extends java.lang.Object
implements java.lang.Comparable<TrackedObject>

A class to track an object that has been profiled Author: Mike Date: 1/9/12 Time: 3:44 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
TrackedObject(java.lang.Object object, java.lang.String field, TrackedObject parent, ProfilingFilter filter) Builds a tracked object around the given object

Method Summary

Modifier and Type	Method and Description
void	addBytes(long bytes) Adds more bytes to that used by this child, and updates the parents
void	addChild(TrackedObject child) Adds a child to this object
int	compareTo(TrackedObject o)
org.jdom.Element	dumpToXML() Outputs this object to XML.
java.util.Set<TrackedObject>	getChildren() Gets all the children of this object
java.lang.String	getClassesPathToObject() Returns a string representing the classes traversed to get to this object from the root object
ProfilingFilter	getFilterUsed() Returns the filter this object used, as a copy
protected ProfilingFilter	getFilterUsedInternal() Returns a reference to the filter used by this object
<T> T	getObject() Returns the object stored by this tracked object
long	getObjectBytes() Get the number of bytes used by just this object, excluding any children
java.lang.Class	getObjectClass() Returns the class of the object tracked by this object
java.lang.String	getObjectName() Gets the name of the field this object came from
TrackedObject	getParent() Returns this object's parent
TrackedObject	getParent(java.lang.Class clazz) Returns the parent with the given name (the nearest relative to this object with that name) or null
TrackedObject	getParent(java.lang.String name) Returns the parent with the given name (the nearest relative to this object with that name) or null
java.lang.String	getPathToObject() Returns a string representation of the path to get to this object from the object profiled
TrackedObject	getThisOrParent(java.lang.Class clazz) Returns the parent with the given name (the nearest relative to this object with that name) or null if not found If the current object matches the class, the current object will be returned
TrackedObject	getThisOrParent(java.lang.String name) Returns the parent with the given name (the nearest relative to this object with that name) or null if not found.
long	getTotalBytes() Get the number of bytes used by this object and it's children
boolean	hasParent() Checks to see if this object has a parent
boolean	hasParent(java.lang.Class clazz) Checks to see if this object has a parent of the given class type
boolean	hasParent(java.lang.String name) Checks to see if this object has a parent with the given name
boolean	isOrHasParent(java.lang.Class clazz) Checks to see if this object has a parent of the given class type
boolean	isOrHasParent(java.lang.String name) Checks to see if this object has a parent with the given name
void	setFilterUsed(ProfilingFilter filter) Sets the filter used by this object
void	setObjectBytes(long bytes) Sets the number of bytes used by this object
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

TrackedObject

public TrackedObject(java.lang.Object object,
                     java.lang.String field,
                     TrackedObject parent,
                     ProfilingFilter filter)

Builds a tracked object around the given object

Parameters:

object - The object being tracked

field - The name of the field this object came from

parent - The parent object, or null if this is the root profiled object

filter - The filter used by the object's parent

Method Detail

getObjectName

public java.lang.String getObjectName()

Gets the name of the field this object came from

Returns:

The object's name

getObjectBytes

public long getObjectBytes()

Get the number of bytes used by just this object, excluding any children

Returns:

The number of bytes used solely by this object

getTotalBytes

public long getTotalBytes()

Get the number of bytes used by this object and it's children

Returns:

The number of bytes used by this object and it's children

setFilterUsed

public void setFilterUsed(ProfilingFilter filter)

Sets the filter used by this object

Parameters:

filter - The filter used by the object

getFilterUsed

@NotNull
public ProfilingFilter getFilterUsed()

Returns the filter this object used, as a copy

Returns:

The filter used by this object

getFilterUsedInternal

protected ProfilingFilter getFilterUsedInternal()

Returns a reference to the filter used by this object

Returns:

A reference to the filter used by this object

getObjectClass

public java.lang.Class getObjectClass()

Returns the class of the object tracked by this object

Returns:

The object's class

setObjectBytes

public void setObjectBytes(long bytes)

Sets the number of bytes used by this object

Parameters:

bytes - The number of bytes used by the object

addBytes

public void addBytes(long bytes)

Adds more bytes to that used by this child, and updates the parents

Parameters:

bytes - The number of bytes to add to this object's usage footprint

getObject

@Nullable
public <T> T getObject()
                           throws java.lang.ClassCastException

Returns the object stored by this tracked object

Type Parameters:

T - The type of the object stored

Returns:

The object represented by this tracked object

Throws:

java.lang.ClassCastException - If the type of T doesn't match the type of the object actually stored

getParent

public TrackedObject getParent()

Returns this object's parent

Returns:

The parent of this object

addChild

public void addChild(TrackedObject child)

Adds a child to this object

Parameters:

child - The child to add

getChildren

@Nullable
public java.util.Set<TrackedObject> getChildren()

Gets all the children of this object

Returns:

The children of this object

hasParent

public boolean hasParent()

Checks to see if this object has a parent

Returns:

True if this object has a parent

hasParent

public boolean hasParent(java.lang.String name)

Checks to see if this object has a parent with the given name

Parameters:

name - The name of the parent object, as the name of the field it came from

Returns:

True if a parent exists with the given field name

hasParent

public boolean hasParent(@NotNull
                         java.lang.Class clazz)

Checks to see if this object has a parent of the given class type

Parameters:

clazz - The class of the parent

Returns:

True if this object has a parent with the given class

getParent

public TrackedObject getParent(java.lang.String name)

Returns the parent with the given name (the nearest relative to this object with that name) or null

Parameters:

name - The parent's name

Returns:

The TrackedObject for the parent with the given field name, or null if not found

getParent

public TrackedObject getParent(@NotNull
                               java.lang.Class clazz)

Returns the parent with the given name (the nearest relative to this object with that name) or null

Parameters:

clazz - The parent's class

Returns:

The TrackedObject for the parent with the given class, or null if not found

isOrHasParent

public boolean isOrHasParent(java.lang.String name)

Checks to see if this object has a parent with the given name

Parameters:

name - The name of the parent object, as the name of the field it came from

Returns:

True if a parent exists with the given field name

isOrHasParent

public boolean isOrHasParent(@NotNull
                             java.lang.Class clazz)

Checks to see if this object has a parent of the given class type

Parameters:

clazz - The class of the parent

Returns:

True if this object has a parent with the given class

getThisOrParent

public TrackedObject getThisOrParent(java.lang.String name)

Returns the parent with the given name (the nearest relative to this object with that name) or null if not found. If the current object matches the name, the current object will be returned

Parameters:

name - The parent's name

Returns:

The TrackedObject for the parent with the given field name, or null if not found

getThisOrParent

public TrackedObject getThisOrParent(@NotNull
                                     java.lang.Class clazz)

Returns the parent with the given name (the nearest relative to this object with that name) or null if not found If the current object matches the class, the current object will be returned

Parameters:

clazz - The parent's class

Returns:

The TrackedObject for the parent with the given class, or null if not found

getPathToObject

public java.lang.String getPathToObject()

Returns a string representation of the path to get to this object from the object profiled

Returns:

The path from the root object profiled to this child

getClassesPathToObject

@NotNull
public java.lang.String getClassesPathToObject()

Returns a string representing the classes traversed to get to this object from the root object

Returns:

The path of classes to this child object from the root object

compareTo

public int compareTo(TrackedObject o)

Specified by:

compareTo in interface java.lang.Comparable<TrackedObject>

toString

@NotNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object

dumpToXML

@NotNull
public org.jdom.Element dumpToXML()

Outputs this object to XML. Only works if the profile was done with the buildChildRelations flag set to true

Returns:

The Jdom element representing this tracked object