com.aicas.jamaica.lang

Class Profile

java.lang.Object

com.aicas.jamaica.lang.Profile

public class Profile
extends Object

Provides control over the profiling facilities of JamaicaVM and contains the jamaicaremoteprofile tool.

Profiling is available only when using the profiling variant of the virtual machine (jamaicavmp) or when option -profile is set when an application is created by the builder.

Constructor Summary

Constructors

Constructor and Description
Profile()

Method Summary

Modifier and Type	Method and Description
static void	dumpProfileAtTerminationOfVM(boolean enabled) Enables dumping of profile information when the VM terminates.
static void	dumpProfileData() Dumps the collected profile data into the given profile file.
static void	dumpProfileData(String filename) Dumps the collected profile data into the given profile file.
static void	dumpProfileDataViaNet(int port) Dumps the collected profile data into the profile file.
static void	forceDumpAtTerminationOfVM(boolean enabled) Overrides the VM's decision to suppress the profile dump if the application did not terminate normally.
static void	main(String[] args) Main routine.
static void	profileClassPath(boolean enabled) Activates profiling of class path information.
static void	profileMemory(boolean enabled) Activates profiling of memory information.
static void	profileSpeed(boolean enabled) Activates profiling of execution speed.
static void	resetProfileData() Reset the collected profile data.
static void	setQuietDump(boolean enabled) Suppresses all messages related to profile creation except errors.
static void	waitOnSocket(int port) Start a profiling thread that waits for requests to dump profiling data on the given port number.

Methods inherited from class java.lang.Object

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

Constructor Detail

Profile

public Profile()

Method Detail

dumpProfileData

public static void dumpProfileData(String filename)

Dumps the collected profile data into the given profile file. This clears the data as well.

Throws:

UnsupportedOperationException - if the VM does not support profiling.

Parameters:

filename - Local file name for the profile. If it is null, the default file name of the application is used.

dumpProfileDataViaNet

public static void dumpProfileDataViaNet(int port)

Dumps the collected profile data into the profile file. This clears the data as well.

Throws:

UnsupportedOperationException - if the VM does not support profiling.

resetProfileData

public static void resetProfileData()

Reset the collected profile data.

Throws:

UnsupportedOperationException - if the VM does not support profiling.

profileMemory

public static void profileMemory(boolean enabled)

Activates profiling of memory information.

Throws:

UnsupportedOperationException - if the VM does not support profiling.

Parameters:

enabled - memory information is collected if true

profileSpeed

public static void profileSpeed(boolean enabled)

Activates profiling of execution speed.

Throws:

UnsupportedOperationException - if the VM does not support profiling.

Parameters:

enabled - execution speed information is collected if true

profileClassPath

public static void profileClassPath(boolean enabled)

Activates profiling of class path information.

Throws:

UnsupportedOperationException - if the VM does not support profiling.

Parameters:

enabled - class path information is collected if true

dumpProfileAtTerminationOfVM

public static void dumpProfileAtTerminationOfVM(boolean enabled)

Enables dumping of profile information when the VM terminates. Note that the VM may override this and suppress the profile dump, for example, if the application did not terminate normally.

Throws:

UnsupportedOperationException - if the VM does not support profiling.

Parameters:

enabled - profile dump is requested if true

forceDumpAtTerminationOfVM

public static void forceDumpAtTerminationOfVM(boolean enabled)

Overrides the VM's decision to suppress the profile dump if the application did not terminate normally.

Throws:

UnsupportedOperationException - if the VM does not support profiling.

Parameters:

enabled - if true, instructs the VM to dump the profile even if the application did not terminate normally

setQuietDump

public static void setQuietDump(boolean enabled)

Suppresses all messages related to profile creation except errors.

Throws:

UnsupportedOperationException - if the VM does not support profiling.

Parameters:

enabled - status messages will be suppressed if and only if true

dumpProfileData

public static void dumpProfileData()

Dumps the collected profile data into the given profile file. This clears the data as well.

Throws:

UnsupportedOperationException - if the VM does not support profiling.

waitOnSocket

public static void waitOnSocket(int port)

Start a profiling thread that waits for requests to dump profiling data on the given port number.

Throws:

IllegalStateException - if the profiling thread is already running.

Parameters:

port - the port number

main

public static void main(String[] args)

Main routine. Connects to an application that requests profiling requests and requests dumping of a profile. Usage: jamaicaremoteprofile

Parameters:

args - the command line arguments, args[0] must give the command name, args[1] must give the IP address, args[2] must give the port number. Option(s) may be specified.