Package org.eclipse.mat.internal.collectionextract

Class TreeMapCollectionExtractor

java.lang.Object

org.eclipse.mat.internal.collectionextract.MapCollectionExtractorBase

org.eclipse.mat.internal.collectionextract.TreeMapCollectionExtractor

All Implemented Interfaces:

ICollectionExtractor, IMapExtractor

Direct Known Subclasses:

TreeMapArrayCollectionExtractor

public class TreeMapCollectionExtractor
extends MapCollectionExtractorBase

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.mat.inspections.collectionextract.IMapExtractor

IMapExtractor.EntryObject

Constructor Summary

Constructors

Constructor	Description
TreeMapCollectionExtractor(String sizeField, String keyField, String valueField)

Method Summary

Modifier and Type	Method	Description
IObjectArray	extractEntries(IObject coll)	Extracts the array containing the collection content
int[]	extractEntryIds(IObject treeMap)	Returns the object ids (int) for all objects which are contained in the collection
Double	getCollisionRatio(IObject collection)	Calculates the collision ratio in the collection.
Double	getFillRatio(IObject coll)	Calculate the fill ratio of a collection
Integer	getNumberOfNotNullElements(IObject coll)	Returns the number of non-null elements in the collection.
Integer	getSize(IObject coll)	Extract the size of the collection.
boolean	hasCollisionRatio()	Check if the extractor can calculate collision ratio
boolean	hasExtractableArray()	Return true if the collection array based and the array can be extracted from the heap dump
boolean	hasExtractableContents()	Check if the collection has extractable contents
boolean	hasFillRatio()	Check if fill ratio for the collection can be calculated, i.e.
boolean	hasSize()	Check if the size of the collection can be extracted.

Methods inherited from class org.eclipse.mat.internal.collectionextract.MapCollectionExtractorBase

extractMapEntries, getCapacity, hasCapacity

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TreeMapCollectionExtractor

public TreeMapCollectionExtractor(String sizeField,
 String keyField,
 String valueField)

Method Details

hasExtractableArray

public boolean hasExtractableArray()

Description copied from interface: ICollectionExtractor

Return true if the collection array based and the array can be extracted from the heap dump

Returns:

true if ICollectionExtractor.extractEntries(IObject) could be called

See Also:

• ICollectionExtractor.extractEntries(IObject)

extractEntries

public IObjectArray extractEntries(IObject coll)
                            throws SnapshotException

Description copied from interface: ICollectionExtractor

Extracts the array containing the collection content

Parameters:

coll - - the collection to find the object array holding its contents

Returns:

the backing array for the collection

Throws:

SnapshotException - if there is a problem retrieving data from the snapshot

See Also:

• ICollectionExtractor.hasExtractableArray()

hasExtractableContents

public boolean hasExtractableContents()

Description copied from interface: ICollectionExtractor

Check if the collection has extractable contents

Returns:

true if ICollectionExtractor.extractEntryIds(IObject) could be called

See Also:

• ICollectionExtractor.extractEntryIds(IObject)

extractEntryIds

public int[] extractEntryIds(IObject treeMap)
                      throws SnapshotException

Description copied from interface: ICollectionExtractor

Returns the object ids (int) for all objects which are contained in the collection

Parameters:

treeMap - - the collection to find the objects it holds

Returns:

an array of ints which are the object ids.

Throws:

SnapshotException - if there is a problem retrieving data from the snapshot

See Also:

• ICollectionExtractor.hasExtractableContents()

hasSize

public boolean hasSize()

Description copied from interface: ICollectionExtractor

Check if the size of the collection can be extracted.

Returns:

true if ICollectionExtractor.getSize(IObject) could be called

See Also:

• ICollectionExtractor.getSize(IObject)

getSize

public Integer getSize(IObject coll)
                throws SnapshotException

Description copied from interface: ICollectionExtractor

Extract the size of the collection.

Parameters:

coll - - the collection to find the size of

Returns:

the size, or null if not available

Throws:

SnapshotException - if there is a problem retrieving data from the snapshot

See Also:

• ICollectionExtractor.hasSize()

getNumberOfNotNullElements

public Integer getNumberOfNotNullElements(IObject coll)
                                   throws SnapshotException

Description copied from interface: ICollectionExtractor

Returns the number of non-null elements in the collection. Requires hasExtractableContents or hasExtractableArray

Parameters:

coll - - the collection to find the number of non-null content objects

Returns:

the number of non-null elements, or null if not available

Throws:

SnapshotException

See Also:

• ICollectionExtractor.hasExtractableContents()
• ICollectionExtractor.hasExtractableArray()

hasCollisionRatio

public boolean hasCollisionRatio()

Description copied from interface: IMapExtractor

Check if the extractor can calculate collision ratio

Returns:

true if @IMapExtractor.getCollisionRatio(IObject) could be called

See Also:

• IMapExtractor.getCollisionRatio(IObject)

getCollisionRatio

public Double getCollisionRatio(IObject collection)

Description copied from interface: IMapExtractor

Calculates the collision ratio in the collection. Could be an estimate.

Parameters:

collection - - the collection to calculate the collision ratio of

Returns:

Double number of elements with colliding keys / size

See Also:

• IMapExtractor.hasCollisionRatio()

hasFillRatio

public boolean hasFillRatio()

Description copied from interface: ICollectionExtractor

Check if fill ratio for the collection can be calculated, i.e. if it has some predefined capacity and actual size.

Returns:

true if ICollectionExtractor.getFillRatio(IObject) could be called

See Also:

• ICollectionExtractor.getFillRatio(IObject)

getFillRatio

public Double getFillRatio(IObject coll)
                    throws SnapshotException

Description copied from interface: ICollectionExtractor

Calculate the fill ratio of a collection

Parameters:

coll - - the collection to find the fill ratio of

Returns:

the fill ratio, between 0.0 and 1.0, or null if unavailable

Throws:

SnapshotException - if there is a problem retrieving data from the snapshot

See Also:

• ICollectionExtractor.hasFillRatio()