Package org.eclipse.mat.internal.collectionextract

Class FieldSizedCapacityCollectionExtractor

java.lang.Object

org.eclipse.mat.internal.collectionextract.FieldArrayCollectionExtractor

org.eclipse.mat.internal.collectionextract.FieldSizeArrayCollectionExtractor

org.eclipse.mat.internal.collectionextract.FieldSizedCapacityCollectionExtractor

All Implemented Interfaces:

ICollectionExtractor

Direct Known Subclasses:

FieldSizedCapacityMapExtractor

public class FieldSizedCapacityCollectionExtractor
extends FieldSizeArrayCollectionExtractor

Constructor Summary

Constructors

Constructor	Description
FieldSizedCapacityCollectionExtractor(String sizeField, String arrayField)

Method Summary

Modifier and Type	Method	Description
IObjectArray	extractEntries(IObject coll)	Extracts the array containing the collection content
int[]	extractEntryIds(IObject coll)	Returns the object ids (int) for all objects which are contained in the collection
IArray	getArray(IObject coll)
Integer	getCapacity(IObject coll)	Return the capacity of the collection, if applicable
Integer	getNumberOfNotNullElements(IObject collection)	Returns the number of non-null elements in the collection.
boolean	hasCapacity()	Check if the collection has capacity, e.g.
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

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

getSize, hasSize

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

getFillRatio, hasFillRatio

Methods inherited from class java.lang.Object

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

Constructor Details

FieldSizedCapacityCollectionExtractor

public FieldSizedCapacityCollectionExtractor(String sizeField,
 String arrayField)

Method Details

hasCapacity

public boolean hasCapacity()

Description copied from interface: ICollectionExtractor

Check if the collection has capacity, e.g. ArrayList

Specified by:

hasCapacity in interface ICollectionExtractor

Overrides:

hasCapacity in class FieldArrayCollectionExtractor

Returns:

true if ICollectionExtractor.getCapacity(IObject) could be called

See Also:

• ICollectionExtractor.getCapacity(IObject)

getArray

public IArray getArray(IObject coll)
                throws SnapshotException

Throws:

SnapshotException

getCapacity

public Integer getCapacity(IObject coll)
                    throws SnapshotException

Description copied from interface: ICollectionExtractor

Return the capacity of the collection, if applicable

Specified by:

getCapacity in interface ICollectionExtractor

Overrides:

getCapacity in class FieldArrayCollectionExtractor

Parameters:

coll - - the collection to find the capacity of

Returns:

the capacity in bytes, or null if unavailable

Throws:

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

See Also:

• ICollectionExtractor.hasCapacity()

hasExtractableContents

public boolean hasExtractableContents()

Description copied from interface: ICollectionExtractor

Check if the collection has extractable contents

Specified by:

hasExtractableContents in interface ICollectionExtractor

Overrides:

hasExtractableContents in class FieldArrayCollectionExtractor

Returns:

true if ICollectionExtractor.extractEntryIds(IObject) could be called

See Also:

• ICollectionExtractor.extractEntryIds(IObject)

extractEntryIds

public int[] extractEntryIds(IObject coll)
                      throws SnapshotException

Description copied from interface: ICollectionExtractor

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

Specified by:

extractEntryIds in interface ICollectionExtractor

Overrides:

extractEntryIds in class FieldArrayCollectionExtractor

Parameters:

coll - - 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()

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

Specified by:

hasExtractableArray in interface ICollectionExtractor

Overrides:

hasExtractableArray in class FieldArrayCollectionExtractor

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

Specified by:

extractEntries in interface ICollectionExtractor

Overrides:

extractEntries in class FieldArrayCollectionExtractor

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()

getNumberOfNotNullElements

public Integer getNumberOfNotNullElements(IObject collection)
                                   throws SnapshotException

Description copied from interface: ICollectionExtractor

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

Specified by:

getNumberOfNotNullElements in interface ICollectionExtractor

Overrides:

getNumberOfNotNullElements in class FieldArrayCollectionExtractor

Parameters:

collection - - 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()