com.goldencode.p2j.util

Interface Profiler

All Superinterfaces:

CommonFile, CommonHandle, Enabled, PseudoWidget, WrappedResource

All Known Subinterfaces:

HandleCommon

public interface Profiler
extends CommonHandle, CommonFile, Enabled, PseudoWidget

Exposes the following methods or attributes from the PROFILER handle:

PROFILER attribute or method	API
PROFILING	isProfiling() and setProfiling(logical)
ENABLED	Enabled.isEnabled() and Enabled.setEnabled(logical)
DESCRIPTION	getDescription() and setDescription(character)
LISTINGS	isListings() and setListings(logical)

This interface is used as a returned type by the handle.unwrapProfiler() API, which, depending on the handle's state, it either returns an ProfilerUtils.asHandle() instance or a dynamic proxy using handle.invalidAttrAccessProxy.

Method Summary

Modifier and Type	Method and Description
handle	asHandle() Get a the instance for the PROFILER system handle.
character	getDescription() Get the value of PROFILER:DESCRIPTION attribute.
character	getDirectory() Get the value of PROFILER:DIRECTORY attribute.
character	getTraceFilter() Get the PROFILER:TRACE-FILTER attribute.
character	getTracing() Get the PROFILER:TRACING attribute.
logical	isCoverage() Get the PROFILER:COVERAGE attribute.
logical	isListings() Get the value of PROFILER:LISTINGS attribute.
logical	isProfiling() Get the value of PROFILER:PROFILING attribute.
void	setCoverage(boolean coverage) Set the PROFILER:COVERAGE attribute.
void	setCoverage(logical coverage) Set the PROFILER:COVERAGE attribute.
void	setDescription(character description) Set the value of PROFILER:DESCRIPTION attribute.
void	setDirectory(character directory) Set the value of PROFILER:DIRECTORY attribute.
void	setListings(logical listings) Set the value of PROFILER:LISTINGS attribute.
void	setProfiling(logical profiling) Set the value of PROFILER:PROFILING attribute.
void	setTraceFilter(character filter) Set the PROFILER:TRACE-FILTER attribute.
void	setTraceFilter(java.lang.String filter) Set the PROFILER:TRACE-FILTER attribute.
void	setTracing(character procs) Set the PROFILER:TRACING attribute.
void	setTracing(java.lang.String procs) Set the PROFILER:TRACING attribute.
logical	userData(character data) Definition of the PROFILER:USER-DATA() method.
logical	userData(java.lang.String data) Definition of the PROFILER:USER-DATA() method.
logical	writeData() Definition of the PROFILER:WRITE-DATA() method.

Methods inherited from interface com.goldencode.p2j.util.CommonHandle

readOnlyError, readOnlyError, resourceType

Methods inherited from interface com.goldencode.p2j.util.WrappedResource

id, id, unknown, valid

Methods inherited from interface com.goldencode.p2j.util.CommonFile

getFileName, initFileInfo, initFileInfo

Methods inherited from interface com.goldencode.p2j.util.Enabled

isEnabled, setEnabled, setEnabled

Method Detail

asHandle

handle asHandle()

Get a the instance for the PROFILER system handle.

Returns:

The handle to the object.

setProfiling

void setProfiling(logical profiling)

Set the value of PROFILER:PROFILING attribute.

Parameters:

profiling - The new value of PROFILER:PROFILING attribute.

isProfiling

logical isProfiling()

Get the value of PROFILER:PROFILING attribute.

Returns:

the value of PROFILER:PROFILING attribute.

setDescription

void setDescription(character description)

Set the value of PROFILER:DESCRIPTION attribute.

Parameters:

description - The new value of PROFILER:DESCRIPTION attribute.

getDescription

character getDescription()

Get the value of PROFILER:DESCRIPTION attribute.

Returns:

the value of PROFILER:DESCRIPTION attribute.

setListings

void setListings(logical listings)

Set the value of PROFILER:LISTINGS attribute.

Parameters:

listings - The new value of PROFILER:LISTINGS attribute.

isListings

logical isListings()

Get the value of PROFILER:LISTINGS attribute.

Returns:

the value of PROFILER:LISTINGS attribute.

setDirectory

void setDirectory(character directory)

Set the value of PROFILER:DIRECTORY attribute.

Parameters:

directory - The new value of PROFILER:DIRECTORY attribute.

getDirectory

character getDirectory()

Get the value of PROFILER:DIRECTORY attribute.

Returns:

the value of PROFILER:DIRECTORY attribute.

userData

logical userData(java.lang.String data)

Definition of the PROFILER:USER-DATA() method.

Parameters:

data - The data.

Returns:

true if the data was written.

userData

logical userData(character data)

Definition of the PROFILER:USER-DATA() method.

Parameters:

data - The data.

Returns:

true if the data was written.

writeData

logical writeData()

Definition of the PROFILER:WRITE-DATA() method.

Returns:

true if the data was written.

getTraceFilter

character getTraceFilter()

Get the PROFILER:TRACE-FILTER attribute.

Returns:

the value of PROFILER:TRACE-FILTER attribute.

setTraceFilter

void setTraceFilter(java.lang.String filter)

Set the PROFILER:TRACE-FILTER attribute.

Parameters:

filter - The filter value.

setTraceFilter

void setTraceFilter(character filter)

Set the PROFILER:TRACE-FILTER attribute.

Parameters:

filter - The filter value.

getTracing

character getTracing()

Get the PROFILER:TRACING attribute.

Returns:

the value of PROFILER:TRACING attribute.

setTracing

void setTracing(java.lang.String procs)

Set the PROFILER:TRACING attribute.

Parameters:

procs - The comma-separated list of procedures.

setTracing

void setTracing(character procs)

Set the PROFILER:TRACING attribute.

Parameters:

procs - The comma-separated list of procedures.

isCoverage

logical isCoverage()

Get the PROFILER:COVERAGE attribute.

Returns:

the value of PROFILER:COVERAGE attribute.

setCoverage

void setCoverage(boolean coverage)

Set the PROFILER:COVERAGE attribute.

Parameters:

coverage - The flag state.

setCoverage

void setCoverage(logical coverage)

Set the PROFILER:COVERAGE attribute.

Parameters:

coverage - The flag state.