Package org.eclipse.mat.ui.internal.acquire

Class ProviderContextImpl

java.lang.Object

org.eclipse.mat.query.registry.QueryContextImpl

org.eclipse.mat.ui.internal.acquire.ProviderContextImpl

All Implemented Interfaces:

IQueryContext

public class ProviderContextImpl
extends QueryContextImpl

Constructor Summary

Constructors

Constructor	Description
ProviderContextImpl()

Method Summary

Modifier and Type	Method	Description
ContextDerivedData	getContextDerivedData()	For example, retained size derived data.
String	getPrefix()	The prefix for files generated from snapshot
File	getPrimaryFile()	The main file for the snapshot
String	mapToExternalIdentifier(int objectId)	Map an id to a readable form.
int	mapToObjectId(String externalIdentifier)	Map readable form to internal id.
Object	parse(Class<?> type, Argument.Advice advice, String[] args, ParsePosition pos)	Consume the special data.
boolean	parses(Class<?> type, Argument.Advice advice)	Is special parsing required to get an object of the required type?

Methods inherited from class org.eclipse.mat.query.registry.QueryContextImpl

available, converts, convertToString, convertToValue, get

Methods inherited from class java.lang.Object

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

Constructor Details

ProviderContextImpl

public ProviderContextImpl()

Method Details

getContextDerivedData

public ContextDerivedData getContextDerivedData()

Description copied from interface: IQueryContext

For example, retained size derived data.

Returns:

the derived data

getPrimaryFile

public File getPrimaryFile()

Description copied from interface: IQueryContext

The main file for the snapshot

Returns:

the dump

getPrefix

public String getPrefix()

Description copied from interface: IQueryContext

The prefix for files generated from snapshot

Returns:

the prefix

mapToExternalIdentifier

public String mapToExternalIdentifier(int objectId)
                               throws SnapshotException

Description copied from interface: IQueryContext

Map an id to a readable form. For example the hex-address with 0x as a prefix. Reverse of IQueryContext.mapToObjectId(java.lang.String)

Parameters:

objectId - The 0-based internal identifier used within MAT.

Returns:

readable external version

Throws:

SnapshotException - if the objectId does not match to a valid object.

See Also:

• IQueryContext.mapToObjectId(java.lang.String)

mapToObjectId

public int mapToObjectId(String externalIdentifier)
                  throws SnapshotException

Description copied from interface: IQueryContext

Map readable form to internal id. Reverse of IQueryContext.mapToExternalIdentifier(int).

Parameters:

externalIdentifier - as provided by IQueryContext.mapToExternalIdentifier(int).

Returns:

the object id

Throws:

SnapshotException - if the external identifier does not match a known object in the snapshot.

parse

public Object parse(Class<?> type,
 Argument.Advice advice,
 String[] args,
 ParsePosition pos)
             throws SnapshotException

Description copied from interface: IQueryContext

Consume the special data. For example using the ArgumentParser for data from a query wizard.

Parameters:

type - The Java type of the destination argument.

advice - Further details about the argument.

args - The source to be converted

pos - Used to index through the array of Strings.

Returns:

the result of parsing the data suitable given the type and advice

Throws:

SnapshotException - If there is a problem in the parsing.

parses

public boolean parses(Class<?> type,
 Argument.Advice advice)

Description copied from interface: IQueryContext

Is special parsing required to get an object of the required type?

Parameters:

type - The Java type of the argument.

advice - Further details about the argument.

Returns:

true if special parsing is needed, for example for a heap object or class object in the heap.