ScriptProfilingEvent

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- com.ibm.itim.script.ScriptProfilingEvent

```
public abstract class ScriptProfilingEvent
extends java.lang.Object
```
Central class that provides profiling for the script framework.

Since:

ITIM 5.0

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String PROFILE_KEY
Key in scriptframework.properties that determines if the profiling should be turned on.

Constructor Summary

Constructors
Constructor and Description

ScriptProfilingEvent()

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract void`	`end(boolean success)` End the profiling and print the results to the trace log (if profiling is turned on).
`static ScriptProfilingEvent`	`get(java.lang.String name)` Return a ScriptProfilingEvent.
`static ScriptProfilingEvent`	`getOn(java.lang.String name)` Return a ScriptProfilingEvent as if profiling is turned on.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PROFILE_KEY
```
public static final java.lang.String PROFILE_KEY
```
    Key in scriptframework.properties that determines if the profiling should be turned on.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ScriptProfilingEvent
```
public ScriptProfilingEvent()
```
- Method Detail
  - get
```
public static ScriptProfilingEvent get(java.lang.String name)
```
    Return a ScriptProfilingEvent. If profiling is turned on then an active event is returned. If profiling is turned off then a null event is returned that does nothing. The null event is a singleton, so no unnecessary memory or time allocating an object is wasted.
    
    Parameters:
    
    name - The name of the host component. To lookup up the language.
    
    Returns:
    
    ScriptProfilingEvent when profiling is on.
  - getOn
```
public static ScriptProfilingEvent getOn(java.lang.String name)
```
    Return a ScriptProfilingEvent as if profiling is turned on. This method exists for testing.
    
    Parameters:
    
    name - The name of the host component. To lookup up the language.
    
    Returns:
    
    ScriptProfilingEvent
  - end
```
public abstract void end(boolean success)
```
    End the profiling and print the results to the trace log (if profiling is turned on).
    
    Parameters:
    
    success - Did the script execute successfully?