java.lang.Object
- org.openjdk.jmc.flightrecorder.memleak.ReferenceTreeObject

All Implemented Interfaces:

IDisplayable, IMCOldObject
```
public class ReferenceTreeObject
extends java.lang.Object
implements IMCOldObject, IDisplayable
```
A data type representing alive objects in a Java heap used in a ReferenceTreeModel.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ReferenceTreeObject.ReferenceTreeObjectType

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`FORMAT_ARRAY_INFO`
`static int`	`FORMAT_FIELD`
`static int`	`FORMAT_OTHER_MODIFIERS`
`static int`	`FORMAT_PACKAGE`
`static int`	`FORMAT_STATIC_MODIFIER`

Fields inherited from interface org.openjdk.jmc.common.IDisplayable
AUTO, EXACT, VERBOSE

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`displayUsing(java.lang.String hint)`
`boolean`	`equals(java.lang.Object o)`
`IQuantity`	`getAddress()`
`IMCOldObjectArray`	`getArray()`
`java.util.List<ReferenceTreeObject>`	`getChildren()`
`java.lang.String`	`getDescription()`
`int`	`getDistanceFromRoot()`
`IMCOldObjectField`	`getField()`
`java.util.Set<IItem>`	`getItems()`	This method is used when it is necessary to get information about all objects this object keeps alive in the `ReferenceTreeModel`.
`double`	`getLeakRelevance()`
`int`	`getObjectsKeptAliveCount()`
`java.util.Map<IQuantity,ReferenceTreeObject>`	`getOldObjectSamples()`
`ReferenceTreeObject`	`getParent()`	This method returns an object that is keeping this object alive.
`IMCOldObject`	`getReferrer()`
`IMCOldObjectArray`	`getReferrerArray()`
`IMCOldObjectField`	`getReferrerField()`
`int`	`getReferrerSkip()`
`java.lang.String`	`getRootDescription()`
`ReferenceTreeObject`	`getRootObject()`
`IQuantity`	`getTimestamp()`
`IMCType`	`getType()`
`int`	`hashCode()`
`void`	`setParent(ReferenceTreeObject parent)`
`java.lang.String`	`toString(int displayFormatting)`	Returns a string representation of this object.
`void`	`updateOldObjectSamples(ReferenceTreeObject oldobjectrefnode)`	This method updates the Root object's Map with allocationTime and its oldObjectReference object (leaves).

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - FORMAT_PACKAGE
```
public static final int FORMAT_PACKAGE
```
    See Also:
    
    Constant Field Values
  - FORMAT_FIELD
```
public static final int FORMAT_FIELD
```
    See Also:
    
    Constant Field Values
  - FORMAT_STATIC_MODIFIER
```
public static final int FORMAT_STATIC_MODIFIER
```
    See Also:
    
    Constant Field Values
  - FORMAT_OTHER_MODIFIERS
```
public static final int FORMAT_OTHER_MODIFIERS
```
    See Also:
    
    Constant Field Values
  - FORMAT_ARRAY_INFO
```
public static final int FORMAT_ARRAY_INFO
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getDistanceFromRoot
```
public int getDistanceFromRoot()
```
    Returns:
    
    the number of steps in a referral chain from the root object
  - getLeakRelevance
```
public double getLeakRelevance()
```
    Returns:
    
    the relevance of this object for memory leak detection
  - getItems
```
public java.util.Set<IItem> getItems()
```
    This method is used when it is necessary to get information about all objects this object keeps alive in the ReferenceTreeModel. E.g. the Mission Control GUI uses this when a user selects a row in the tree to show everything below it as well in the properties view.
    
    Returns:
    
    a set representing all IItem objects this object keeps alive, including itself
  - getRootDescription
```
public java.lang.String getRootDescription()
```
    Returns:
    
    the GC root description
  - getAddress
```
public IQuantity getAddress()
```
    Specified by:
    
    getAddress in interface IMCOldObject
  - getReferrerArray
```
public IMCOldObjectArray getReferrerArray()
```
    Specified by:
    
    getReferrerArray in interface IMCOldObject
  - getArray
```
public IMCOldObjectArray getArray()
```
    Returns:
    
    if this object is an array, gets information representing that array, null otherwise
  - getChildren
```
public java.util.List<ReferenceTreeObject> getChildren()
```
    Returns:
    
    the children of this object
  - getReferrerField
```
public IMCOldObjectField getReferrerField()
```
    Specified by:
    
    getReferrerField in interface IMCOldObject
  - getField
```
public IMCOldObjectField getField()
```
    Returns:
    
    if this object is a field, gets information representing that field, null otherwise
  - getDescription
```
public java.lang.String getDescription()
```
    Specified by:
    
    getDescription in interface IMCOldObject
  - getObjectsKeptAliveCount
```
public int getObjectsKeptAliveCount()
```
    Returns:
    
    the number of objects this object keeps alive
  - getParent
```
public ReferenceTreeObject getParent()
```
    This method returns an object that is keeping this object alive.
    
    Returns:
    
    the object linking to this object from the direction of the gc root
  - getReferrer
```
public IMCOldObject getReferrer()
```
    Specified by:
    
    getReferrer in interface IMCOldObject
  - getTimestamp
```
public IQuantity getTimestamp()
```
    Returns:
    
    the timestamp this object was allocated
  - getType
```
public IMCType getType()
```
    Specified by:
    
    getType in interface IMCOldObject
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - setParent
```
public void setParent(ReferenceTreeObject parent)
```
    Parameters:
    
    parent - the parent of this object
  - getRootObject
```
public ReferenceTreeObject getRootObject()
```
    Returns:
    
    the Root object
  - getReferrerSkip
```
public int getReferrerSkip()
```
    Specified by:
    
    getReferrerSkip in interface IMCOldObject
  - getOldObjectSamples
```
public java.util.Map<IQuantity,ReferenceTreeObject> getOldObjectSamples()
```
    Returns:
    
    Map containing allocation time and its oldObjectReference object
  - updateOldObjectSamples
```
public void updateOldObjectSamples(ReferenceTreeObject oldobjectrefnode)
```
    This method updates the Root object's Map with allocationTime and its oldObjectReference object (leaves).
    
    Parameters:
    
    oldobjectrefnode - oldObjectReference leaf node
  - displayUsing
```
public java.lang.String displayUsing(java.lang.String hint)
```
    Specified by:
    
    displayUsing in interface IDisplayable
  - toString
```
public java.lang.String toString(int displayFormatting)
```
    Returns a string representation of this object.
    
    Parameters:
    
    displayFormatting - an int describing how this object is to be represented, using bitwise masking of constants defined in ReferenceTreeObject
    
    Returns:
    
    a human readable string representation of this object

Class ReferenceTreeObject

Nested Class Summary

Field Summary

Fields inherited from interface org.openjdk.jmc.common.IDisplayable

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FORMAT_PACKAGE

FORMAT_FIELD

FORMAT_STATIC_MODIFIER

FORMAT_OTHER_MODIFIERS

FORMAT_ARRAY_INFO

Method Detail

getDistanceFromRoot

getLeakRelevance

getItems

getRootDescription

getAddress

getReferrerArray

getArray

getChildren

getReferrerField

getField

getDescription

getObjectsKeptAliveCount

getParent

getReferrer

getTimestamp

getType

hashCode

equals

setParent

getRootObject

getReferrerSkip

getOldObjectSamples

updateOldObjectSamples

displayUsing

toString