Package org.eclipse.mat.snapshot.query
Class ObjectListResult.Inbound
java.lang.Object
org.eclipse.mat.snapshot.query.ObjectListResult.Inbound
- All Implemented Interfaces:
IDecorator,IIconProvider,IResult,IResultTree,IStructuredResult
- Enclosing class:
- ObjectListResult
Helper class which describes a tree of objects by inbound references.
-
Field Summary
Fields inherited from interface org.eclipse.mat.query.IIconProvider
EMPTY -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal List<?>getChildren(Object parent) Returns the child elements of the given parent.final Column[]Get the columns, which are the class name, the shallow heap and the retained heap.final ObjectgetColumnValue(Object row, int columnIndex) Returns the (unformatted) value of a table/tree cell.final IContextObjectgetContext(Object row) The default context of the row which is used to display information in the object inspector.final List<?>Get the actual rows.Get the URL for a row of the tree.final ResultMetaDataEnhance the tree with extra data.final booleanhasChildren(Object element) Returns whether the given element has children.final StringAdd before the object for example <local>final StringAdd after the object
-
Constructor Details
-
Inbound
Construct a inbound references tree- Parameters:
snapshot- the snapshotobjectIds- the set of objects to form roots of the trees
-
-
Method Details
-
getIcon
Get the URL for a row of the tree. Returns either an arrow item or the base icon if no children.- Returns:
- the URL of the icon
-
getResultMetaData
Enhance the tree with extra data.- Specified by:
getResultMetaDatain interfaceIResult- Returns:
- the metadata for the result, used to obtain extra data
-
getColumns
Get the columns, which are the class name, the shallow heap and the retained heap.- Specified by:
getColumnsin interfaceIStructuredResult- Returns:
- an array of all the columns
-
getElements
Get the actual rows.- Specified by:
getElementsin interfaceIResultTree- Returns:
- a list of all the root elements of the tree
as opaque row objects representing each row
which can be passed to
IResultTree.getChildren(Object)orIStructuredResult.getContext(Object)orIStructuredResult.getColumnValue(Object, int).
-
getChildren
Description copied from interface:IResultTreeReturns the child elements of the given parent.- Specified by:
getChildrenin interfaceIResultTree- Parameters:
parent- The row object as returned by theIResultTree.getElements()orIResultTree.getChildren(Object)methods.- Returns:
- a list of children of this branch of the tree
-
hasChildren
Description copied from interface:IResultTreeReturns whether the given element has children.- Specified by:
hasChildrenin interfaceIResultTree- Parameters:
element- the opaque object used to indicate which branch- Returns:
- true if this element has children
-
getColumnValue
Description copied from interface:IStructuredResultReturns the (unformatted) value of a table/tree cell.- Specified by:
getColumnValuein interfaceIStructuredResult- Parameters:
row- The row object as returned by theIResultTable.getRow(int)orIResultTree.getElements()orIResultTree.getChildren(Object)methodscolumnIndex- The index of the column.- Returns:
- the cell value
-
getContext
Description copied from interface:IStructuredResultThe default context of the row which is used to display information in the object inspector. Unless no context provider is given via theResultMetaData, it is also used for the context menu on a row.- Specified by:
getContextin interfaceIStructuredResult- Parameters:
row- The row object as returned by theIResultTable.getRow(int)orIResultTree.getElements()orIResultTree.getChildren(Object)methods.- Returns:
- a context object holding details about that row
-
prefix
Description copied from interface:IDecoratorAdd before the object for example <local>- Specified by:
prefixin interfaceIDecorator- Parameters:
row- used to find the row- Returns:
- the prefix or null
-
suffix
Description copied from interface:IDecoratorAdd after the object- Specified by:
suffixin interfaceIDecorator- Parameters:
row- used to find the row- Returns:
- the suffix or null
-