Module openj9.dtfj

Package com.ibm.dtfj.javacore.builder

Interface IImageBuilder

All Known Implementing Classes:

ImageBuilder

public interface IImageBuilder

Image building factory for com.ibm.dtfj.image.Image

Support for multiple address spaces: If a javacore contains multiple address spaces, each with its own set of processes and runtimes, it is assumed that some sort of unique ID in the javacore (could be start address of address space) is used to distinguish each address space, and that the proper addressSpaceBuilder can be selected throughout the parsing process by parsing a tag in the javacore that contains this id.

Method Summary

Modifier and Type	Method	Description
void	addHostAddr(InetAddress addr)	Add a host address
IImageAddressSpaceBuilder	generateAddressSpaceBuilder(String id)	Generates a valid image address space factory and associates it with this image factory.
IImageAddressSpaceBuilder	getAddressSpaceBuilder(String builderID)
IImageAddressSpaceBuilder	getCurrentAddressSpaceBuilder()	At least one image address space factory must exist for each image builder factory.
Image	getImage()	Get com.ibm.dtfj.image.Image being build by this image factory
void	setcpuCount(int cpuCount)	Set CPU count
void	setcpuSubType(String cpuSubType)	Set CPU sub-type
void	setcpuType(String cpuType)	Set CPU type - equivalent to os.arch property
void	setCreationTime(long creationTime)	Set the time the dump was created
void	setCreationTimeNanos(long nanoTime)	Set the nanotime the dump was created
void	setHostName(String hostName)	Set host name
void	setOSSubType(String osSubType)	Set OS sub-type, equivalent to os.version property
void	setOSType(String osType)	Set OS type, equivalent to os.name property

Method Details

getAddressSpaceBuilder

IImageAddressSpaceBuilder getAddressSpaceBuilder(String builderID)

Parameters:

builderID - unique id to lookup an image address space factory

Returns:

image address space factory if found, or null

getCurrentAddressSpaceBuilder

IImageAddressSpaceBuilder getCurrentAddressSpaceBuilder()

At least one image address space factory must exist for each image builder factory. In multiple image address space scenarios, the last image address space factory generated may be considered the current one.

Returns:

current image address space factory. Must not be null.

getImage

Image getImage()

Get com.ibm.dtfj.image.Image being build by this image factory

Returns:

valid Image. Must not be null.

generateAddressSpaceBuilder

IImageAddressSpaceBuilder generateAddressSpaceBuilder(String id)
                                               throws BuilderFailureException

Generates a valid image address space factory and associates it with this image factory. Must return a valid image address space factory or throw exception if an error occurred generating the image address space factory.
At least one image address space factory must be created with a unique id for each image factory.

Parameters:

id - unique id

Returns:

generated image address space factory

Throws:

BuilderFailureException - if image address space factory could not be generated

setOSType

void setOSType(String osType)

Set OS type, equivalent to os.name property

Parameters:

osType -

setOSSubType

void setOSSubType(String osSubType)

Set OS sub-type, equivalent to os.version property

Parameters:

osSubType -

setcpuType

void setcpuType(String cpuType)

Set CPU type - equivalent to os.arch property

Parameters:

cpuType -

setcpuSubType

void setcpuSubType(String cpuSubType)

Set CPU sub-type

Parameters:

cpuSubType -

setcpuCount

void setcpuCount(int cpuCount)

Set CPU count

Parameters:

cpuCount -

setCreationTime

void setCreationTime(long creationTime)

Set the time the dump was created

Parameters:

creationTime - the time

setCreationTimeNanos

void setCreationTimeNanos(long nanoTime)

Set the nanotime the dump was created

Parameters:

nanoTime - the time

setHostName

void setHostName(String hostName)

Set host name

Parameters:

hostName -

addHostAddr

void addHostAddr(InetAddress addr)

Add a host address

Parameters:

addr - The IP address to add