blob: b1273d7a565323e8256ae251798323a0ba46ef28 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-us" lang="en-us">
<head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta name="generator" content="DITA-OT" /><meta name="DC.type" content="reference" />
<meta name="DC.title" content="Path to GC Roots" />
<meta name="abstract" content="Find out who is keeping alive a single object." />
<meta name="description" content="Find out who is keeping alive a single object." />
<meta name="copyright" content="Copyright (c) 2008, 2023 SAP AG and others. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-2.0/ " type="primary" />
<meta name="DC.rights.owner" content="Copyright (c) 2008, 2023 SAP AG and others. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-2.0/ " type="primary" />
<meta name="DC.format" content="XHTML" />
<meta name="DC.identifier" content="ref_inspections_path_to_gc_roots" />
<meta name="DC.language" content="en-us" />
<link rel="stylesheet" type="text/css" href="../../styles/commonltr.css" />
<title>Path to GC Roots</title>
</head>
<body id="ref_inspections_path_to_gc_roots">
<h1 class="title topictitle1" id="ariaid-title1">Path to GC Roots</h1>
<div class="body refbody"><p class="shortdesc">Find out who is keeping alive a single object.
</p>
<div class="section"><h2 class="title sectiontitle">Motivation</h2>
<p class="p">Having found an expensive object it is then important to find all the reasons it is kept alive.</p>
</div>
<div class="section"><h2 class="title sectiontitle">Arguments</h2>
<table cellpadding="4" cellspacing="0" summary="" border="1" class="simpletable"><col style="width:50%" /><col style="width:50%" /><thead><tr class="sthead">
<th style="vertical-align:bottom;text-align:left;" id="d8051e47" class="stentry">Argument</th>
<th style="vertical-align:bottom;text-align:left;" id="d8051e50" class="stentry">Description</th>
</tr>
</thead><tbody><tr class="strow">
<td style="vertical-align:top;" headers="d8051e47" class="stentry">object</td>
<td style="vertical-align:top;" headers="d8051e50" class="stentry">One object for which the paths to GC roots should be found.</td>
</tr>
<tr class="strow">
<td style="vertical-align:top;" headers="d8051e47" class="stentry"><span class="keyword parmname">-excludes</span></td>
<td style="vertical-align:top;" headers="d8051e50" class="stentry">Fields of certain classes which should be ignored when finding paths. For example this allows paths through Weak or Soft Reference referents to be ignored.
This is of the format <var class="keyword varname">class name pattern</var>[:<var class="keyword varname">field name</var>[,<var class="keyword varname">field name</var>]*].
Subclasses of the class are also included.
If no field names are specified for the class then all fields are excluded.
</td>
</tr>
<tr class="strow">
<td style="vertical-align:top;" headers="d8051e47" class="stentry"><span class="keyword parmname">-numberofpaths</span></td>
<td style="vertical-align:top;" headers="d8051e50" class="stentry">The number of different paths to be displayed.</td>
</tr>
</tbody></table>
</div>
<div class="section" id="ref_inspections_path_to_gc_roots__result"><h2 class="title sectiontitle">Result</h2>
<img class="image" src="../../gettingstarted/basictutorial_path.png" alt="A tree view showing paths to a field object." />
<div class="note"><span class="notetitle">Note:</span> With the arrows in each <a class="xref" href="../iconassist.html">
<img class="image" src="../../mimes/i-horefabove.png" alt="Icon of a piece of paper with an arrow at the top left pointing up and to the left." />
icon</a> points up and to the left, showing
that the field in <strong class="ph b">bold</strong> of the object of a line actually refers
to the preceding object in the tree view which is up and to the left.</div>
</div>
</div>
</body>
</html>