Helper (byteman-root 2.1.4.1 API)

java.lang.Object
- org.jboss.byteman.rule.helper.Helper

Direct Known Subclasses:

BytemanTestHelper, InterpretedHelper, JMXHelper, PeriodicHelper, ThreadHistoryMonitorHelper, ThreadMonitorHelper
```
public class Helper
extends Object
```
This is the default helper class which is used to define builtin operations for rules. Methods provided on this class are automatically made available as builtin operations in expressions appearing in rule event bindings, conditions and actions. Although Helper methods are all instance methods the message recipient for the method call is implicit and does not appear in the builtin call. It does, however, appear in the runtime invocation, giving the builtin operation access to the helper and thence the rule being fired.

Field Summary

Fields
Modifier and Type Field and Description

protected Rule rule

Fields
Modifier and Type	Field and Description
`protected Rule`	`rule`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Helper(Rule rule)

Constructors
Modifier	Constructor and Description
`protected`	`Helper(Rule rule)`

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`activated()`
`boolean`	`addCountDown(Object identifier, int count)` alias for createCountDown provided for backwards compatibility
`boolean`	`callerCheck(String match, boolean isRegExp, boolean includeClass, boolean includePackage, int startFrame, int frameCount)` test whether the name of any of the selected methods in the stack which called the trigger method matches the supplied regular expression.
`boolean`	`callerEquals(String name)` test whether the name of the method which called the the trigger method matches the supplied name by calling callerEquals(name, false)
`boolean`	`callerEquals(String name, boolean includeClass)` test whether the name of method which called the the trigger method matches the supplied name by calling callerEquals(name, includeClass, false)
`boolean`	`callerEquals(String name, boolean includeClass, boolean includePackage)` test whether the name of method which called the the trigger method matches the supplied name by calling callerEquals(name, includeClass, includePackage, 1)
`boolean`	`callerEquals(String name, boolean includeClass, boolean includePackage, int frameCount)` test whether the name of any of the selected methods in the stack which called the trigger method matches the supplied name by calling callerCheck(name, false, includeClass, includePackage, 1, frameCount)
`boolean`	`callerEquals(String name, boolean includeClass, boolean includePackage, int startFrame, int frameCount)` test whether the name of any of the selected methods in the stack which called the trigger method matches the supplied name by calling callerCheck(name, false, includeClass, false, startFrame, frameCount)
`boolean`	`callerEquals(String name, boolean includeClass, int frameCount)` test whether the name of method which called the the trigger method matches the supplied name by calling callerEquals(name, includeClass, false, frameCount)
`boolean`	`callerEquals(String name, boolean includeClass, int startFrame, int frameCount)` test whether the name of method which called the the trigger method matches the supplied name by calling callerEquals(name, includeClass, false, startFrame, frameCount)
`boolean`	`callerEquals(String name, int frameCount)` test whether the name of any of the selected methods in the stack which called the trigger method matches the supplied name by calling callerEquals(name, 1, frameCount)
`boolean`	`callerEquals(String name, int startFrame, int frameCount)` test whether the name of any of the selected methods in the stack which called the trigger method matches the supplied name by calling callerEquals(name, false, startFrame, frameCount)
`boolean`	`callerMatches(String regExp)` test whether the name of the method which called the the trigger method matches the supplied regular by calling callerMatches(regExp, false)
`boolean`	`callerMatches(String regExp, boolean includeClass)` test whether the name of method which called the the trigger method matches the supplied regular expression by calling callerMatches(regExp, includeClass, false)
`boolean`	`callerMatches(String regExp, boolean includeClass, boolean includePackage)` test whether the name of method which called the the trigger method matches the supplied regular expression by calling callerMatches(regExp, includeClass, includePackage, 1)
`boolean`	`callerMatches(String regExp, boolean includeClass, boolean includePackage, int frameCount)` test whether the name of method which called the the trigger method matches the supplied regular expression by calling callerMatches(regExp, includeClass, includePackage, 1, frameCount)
`boolean`	`callerMatches(String regExp, boolean includeClass, boolean includePackage, int startFrame, int frameCount)` test whether the name of any of the selected methods in the stack which called the trigger method matches the supplied regular expression by calling callerCheck(regExp, true, includeClass, includePackage, 1, frameCount)
`boolean`	`callerMatches(String regExp, boolean includeClass, int frameCount)` test whether the name of method which called the the trigger method matches the supplied regular expression by calling callerMatches(regExp, includeClass, false, frameCount)
`boolean`	`callerMatches(String regExp, boolean includeClass, int startFrame, int frameCount)` test whether the name of method which called the the trigger method matches the supplied regular expression by calling callerMatches(regExp, includeClass, false, startFrame, frameCount)
`boolean`	`callerMatches(String regExp, int frameCount)` test whether the name of any of the selected methods in the stack which called the trigger method matches the supplied regular expression by calling callerMatches(regExp, 1, frameCount)
`boolean`	`callerMatches(String regExp, int startFrame, int frameCount)` test whether the name of any of the selected methods in the stack which called the trigger method matches the supplied regular expression by calling callerMatches(regExp, false, startFrame, frameCount)
`boolean`	`clear(Object identifier)` clear the flag keyed by the supplied object if it is not already clear
`boolean`	`closeTrace(Object identifier)` version for backwards compatibility -- docs and original code were mismatched
`boolean`	`countDown(Object identifier)` builtin to decrement the countdown identified by a specific object, uninstalling it and returning true only when the count is zero.
`boolean`	`createCountDown(Object identifier, int count)` builtin to test create a countdown identified by a specific object and with the specified count.
`boolean`	`createCounter(Object o)` create a counter identified by the given object with count 0 as its initial count
`boolean`	`createCounter(Object o, int value)` create a counter identified by the given object with the supplied value as its iniital count
`boolean`	`createJoin(Object key, int max)`
`boolean`	`createRendezvous(Object identifier, int expected)` call createRendezvous(Object, int, boolean) supplying false for the last parameter
`boolean`	`createRendezvous(Object identifier, int expected, boolean restartable)` create a rendezvous for a given number of threads to join
`boolean`	`createTimer(Object o)` create a timer identified by the given object
`static void`	`deactivated()`
`boolean`	`debug(String text)` builtin to print a message during rule execution.
`int`	`decrementCounter(Object o)` decrement the value of the counter associated with given identifier, creating a new one with count zero if none exists
`void`	`delay(long millisecs)` delay execution of the current thread for a specified number of milliseconds
`boolean`	`deleteCounter(Object o)` delete a counter identified by the given object with count 0 as its initial count
`boolean`	`deleteRendezvous(Object identifier, int expected)`
`boolean`	`deleteTimer(Object o)` delete a timer identified by the given object
`boolean`	`flag(Object identifier)` set a flag keyed by the supplied object if it is not already set
`boolean`	`flagged(Object identifier)` test the state of the flag keyed by the supplied object
`String`	`formatAllStacks()` return all stack traces by calling formatAllStacks(null)
`String`	`formatAllStacks(int maxFrames)` return all stack traces by calling formatAllStacks(null, maxFrames)
`String`	`formatAllStacks(String prefix)` return all stack traces by calling formatAllStacks(prefix, 0)
`String`	`formatAllStacks(String prefix, int maxFrames)` return all stack traces
`String`	`formatStack()` return a stack trace by calling formatStack(null)
`String`	`formatStack(int maxFrames)` return a stack trace by calling formatStack(null, maxFrames)
`String`	`formatStack(String prefix)` return a stack trace by calling formatStack(prefix, 0)
`String`	`formatStack(String prefix, int maxFrames)` print a stack trace to the trace stream identified by key
`String`	`formatStackBetween(String from, String to)` return a String tracing the stack between the frames which match start and end by calling formatStackBetween(from, to, null)
`String`	`formatStackBetween(String from, String to, boolean includeClass)` return a String tracing the stack between the frames which match start and end by calling formatStackBetween(from, to, includeClass, false)
`String`	`formatStackBetween(String from, String to, boolean includeClass, boolean includePackage)` return a String tracing the stack between the frames which match start and end by calling formatStackBetween(from, to, includeClass, includePackage, null)
`String`	`formatStackBetween(String from, String to, boolean includeClass, boolean includePackage, String prefix)` return a String tracing the stack between the frames which match start and end by calling formatStackRange(from, to, false, includeClass, includePackage, prefix)
`String`	`formatStackBetween(String from, String to, boolean includeClass, String prefix)` return a String tracing the stack between the frames which match start and end by calling formatStackBetween(from, to, includeClass, false, prefix)
`String`	`formatStackBetween(String from, String to, String prefix)` return a String tracing the stack between the frames which match start and end by calling formatStackBetween(from, to, false, false, false, prefix)
`String`	`formatStackBetweenMatches(String from, String to)` return a String tracing the stack between the frames which match start and end by calling formatStackBetweenMatches(from, to, null)
`String`	`formatStackBetweenMatches(String from, String to, boolean includeClass)` return a String tracing the stack between the frames which match start and end by calling formatStackBetweenMatches(from, to, includeClass, false)
`String`	`formatStackBetweenMatches(String from, String to, boolean includeClass, boolean includePackage)` return a String tracing the stack between the frames which match start and end by calling formatStackBetweenMatches(from, to, includeClass, includePackage, null)
`String`	`formatStackBetweenMatches(String from, String to, boolean includeClass, boolean includePackage, String prefix)` return a String tracing the stack between the frames which match start and end by calling formatStackRange(from, to, true, includeClass, includePackage, prefix)
`String`	`formatStackBetweenMatches(String from, String to, boolean includeClass, String prefix)` return a String tracing the stack between the frames which match start and end by calling formatStackBetweenMatches(from, to, includeClass, false, prefix)
`String`	`formatStackBetweenMatches(String from, String to, String prefix)` return a String tracing the stack between the frames which match start and end by calling formatStackBetweenMatches(from, to, false, false, false, prefix)
`String`	`formatStackMatching(String regExp)` return a String tracing all stack frames which match pattern by calling formatStackMatching(pattern, null)
`String`	`formatStackMatching(String regExp, boolean includeClass)` return a String tracing all stack frames which match pattern by calling formatStackMatching(pattern, includeClass, false)
`String`	`formatStackMatching(String regExp, boolean includeClass, boolean includePackage)` return a String tracing all stack frames which match pattern by calling formatStackMatching(pattern, includeClass, includePackage, null)
`String`	`formatStackMatching(String regExp, boolean includeClass, boolean includePackage, String prefix)` return a String tracing all stack frames which match pattern.
`String`	`formatStackMatching(String regExp, boolean includeClass, String prefix)` return a String tracing all stack frames which match pattern by calling formatStackMatching(pattern, includeClass, false, prefix)
`String`	`formatStackMatching(String regExp, String prefix)` return a String tracing all stack frames which match pattern by calling formatStackMatching(pattern, false, prefix)
`String`	`formatStackRange(String from, String to, boolean isRegExp, boolean includeClass, boolean includePackage, String prefix)` return a String tracing the stack between the frames which match start and end.
`String`	`formatThreadStack(String threadName)` return stack traces of a specific thread by calling formatThreadStack(threadName, null)
`String`	`formatThreadStack(String threadName, int maxFrames)` return all stack traces by calling formatThreadStack(threadName, null, maxFrames)
`String`	`formatThreadStack(String threadName, String prefix)` return all stack traces by calling formatThreadStack(threadName, prefix, 0)
`String`	`formatThreadStack(String threadName, String prefix, int maxFrames)` return all stack traces
`boolean`	`getCountDown(Object identifier)` for backwards compatibility
`long`	`getElapsedTimeFromTimer(Object o)` get the elapsed time from the start (or last reset) of timer associated with given identifier, creating a new one if none exists
`long`	`getObjectSize(Object o)` provide an estimate of an object's size return -1 if not running in a real agent
`int`	`getRendezvous(Object identifier, int expected)` test whether a rendezvous with a specific expected count is associated with identifier
`protected StackTraceElement[]`	`getStack()` access to the current stack frames
`int`	`incrementCounter(Object o)` increment the value of the counter associated with given identifier, creating a new one with count zero if none exists
`int`	`incrementCounter(Object o, int amount)` increment the value of the counter associated with given identifier by the given amount, creating a new one with count zero if none exists
`static void`	`installed(Rule rule)`
`boolean`	`isCountDown(Object identifier)` builtin to test test if a countdown has been installed
`boolean`	`isJoin(Object key, int max)`
`boolean`	`isRendezvous(Object identifier, int expected)` test whether a rendezvous with a specific expected count is associated with identifier
`boolean`	`joinEnlist(Object key)`
`boolean`	`joinWait(Object key, int count)`
`void`	`killJVM()` cause the current JVM to halt immediately, simulating a crash as near as possible.
`void`	`killJVM(int exitCode)` cause the current JVM to halt immediately, simulating a crash as near as possible.
`void`	`killThread()` cause the current thread to throw a runtime exception which will normally cause it to exit.
`protected int`	`matchIndex(StackTraceElement[] stack, String pattern, boolean isRegExp, boolean includeClass, boolean includePackage, int start, int limit)` return the index of the first frame at or below index start which matches pattern
`boolean`	`openTrace(Object identifier)` version for backwards compatibility -- docs and original code were mismatched
`boolean`	`openTrace(Object identifier, String fileName)` version for backwards compatibility -- docs and original code were mismatched
`protected void`	`printFrame(StringBuffer buffer, StackTraceElement frame)` print the details of stack frame to buffer
`protected void`	`printlnFrame(StringBuffer buffer, StackTraceElement frame)` print the details of stack frame followed by a newline to buffer by calling printlnFrame(buffer, frame) then buffer.append('\n')
`int`	`readCounter(Object o)` read the value of the counter associated with given identifier, creating a new one with count zero if none exists
`int`	`readCounter(Object o, boolean zero)` read and optionally reset to zero the value of the counter associated with given identifier, creating a new one with count zero if none exists
`int`	`rendezvous(Object identifier)` meet other threads at a given rendezvous returning only when the expected number have arrived
`long`	`resetTimer(Object o)` reset the timer associated with given identifier, creating a new one if none exists
`void`	`setTriggering(boolean enabled)` enable or disable recursive triggering of rules by subsequent operations performed during binding, testing or firing of the current rule in the current thread.
`boolean`	`signalKill(Object identifier)` for backwards compatibility
`boolean`	`signalKill(Object identifier, boolean mustMeet)` for backwards compatibility
`boolean`	`signalThrow(Object identifier)` call signalThrow(Object, boolean) defaulting the second argument to false
`boolean`	`signalThrow(Object identifier, boolean mustMeet)` signal an event identified by the suppied object, causing all waiting threads to throw an exception and clearing the event.
`boolean`	`signalWake(Object identifier)` call signalWake(Object, boolean) defaulting the second argument to false
`boolean`	`signalWake(Object identifier, boolean mustMeet)` signal an event identified by the supplied object, causing all waiting threads to resume rule processing and clearing the event.
`String`	`toString()` return a unique name for the trigger point associated with this rule.
`boolean`	`trace(Object identifier, String message)` write the supplied message to the trace stream identified by identifier, creating a new stream if none exists
`boolean`	`trace(String message)` call trace("out, message").
`void`	`traceAllStacks()` print trace of all threads' stacks to System.out by calling traceAllStacks(null)
`void`	`traceAllStacks(int maxFrames)` print trace of all threads' stacks to System.out by calling traceAllStacks(null, maxFrames)
`void`	`traceAllStacks(String prefix)` print trace of all threads' stacks to System.out by calling traceAllStacks(prefix, "out")
`void`	`traceAllStacks(String prefix, int maxFrames)` print trace of all threads' stacks to System.out by calling traceAllStacks(prefix, "out", maxFrames)
`void`	`traceAllStacks(String prefix, Object key)` print trace of all threads' stacks to the trace stream identified by key by calling traceAllStacks(prefix, key, 0)
`void`	`traceAllStacks(String prefix, Object key, int maxFrames)` print trace of all threads' stacks to the trace stream identified by key
`boolean`	`traceClose(Object identifier)` close the trace output stream identified by identifier flushing any pending output
`boolean`	`traceln(Object identifier, String message)` write the supplied message to the trace stream identified by identifier, creating a new stream if none exists, and append a new line
`boolean`	`traceln(String message)` call traceln("out", message).
`boolean`	`traceOpen(Object identifier)` open a trace output stream identified by identifier to a file located in the current working directory using a unique generated name
`boolean`	`traceOpen(Object identifier, String fileName)` open a trace output stream identified by identifier to a file located in the current working directory using the given file name or a generated name if the supplied name is null
`void`	`traceStack()` print a stack trace to System.out by calling traceStack(null)
`void`	`traceStack(int maxFrames)` print a stack trace to System.out by calling traceStack(null, maxFrames)
`void`	`traceStack(String prefix)` print a stack trace to System.out by calling traceStack(prefix, "out")
`void`	`traceStack(String prefix, int maxFrames)` print a stack trace to System.out by calling traceStack(prefix, "out", maxFrames)
`void`	`traceStack(String prefix, Object key)` print a stack trace to the trace stream identified by key by calling traceStack(prefix, key, 0)
`void`	`traceStack(String prefix, Object key, int maxFrames)` print a stack trace to the trace stream identified by key
`void`	`traceStackBetween(String from, String to)` print all stack frames between the frames which match start and end to System.out by calling traceStackBetween(from, to, null)
`void`	`traceStackBetween(String from, String to, boolean includeClass)` print all stack frames between the frames which match start and end to System.out by calling traceStackBetween(from, to, includeClass, false)
`void`	`traceStackBetween(String from, String to, boolean includeClass, boolean includePackage)` print all stack frames between the frames which match start and end to System.out by calling traceStackBetween(from, to, includeClass, includePackage, null)
`void`	`traceStackBetween(String from, String to, boolean includeClass, boolean includePackage, String prefix)` print all stack frames between the frames which match start and end to System.out preceded by prefix by calling traceStackBetween(from, to, includeClass, includePackage, prefix, "out")
`void`	`traceStackBetween(String from, String to, boolean includeClass, boolean includePackage, String prefix, Object key)` print all stack frames between the frames which match start and end preceded by prefix by calling traceStackBetween(from, to, false, includeClass, includePackage, prefix, key)
`void`	`traceStackBetween(String from, String to, boolean includeClass, String prefix)` print all stack frames between the frames which match start and end to System.out by calling traceStackBetween(from, to, includeClass, false, prefix)
`void`	`traceStackBetween(String from, String to, boolean includeClass, String prefix, Object key)` print all stack frames between the frames which match start and end preceded by prefix by calling traceStackBetween(from, to, includeClass, false, prefix, key)
`void`	`traceStackBetween(String from, String to, String prefix)` print all stack frames between the frames which match start and end to System.out preceded by prefix by calling traceStackBetween(from, to, prefix, "out")
`void`	`traceStackBetween(String from, String to, String prefix, Object key)` print all stack frames between the frames which match start and end preceded by prefix by calling traceStackBetween(from, to, false, prefix, key)
`void`	`traceStackBetweenMatches(String from, String to)` print all stack frames between the frames which match start and end to System.out by calling traceStackBetweenMatches(from, to, null)
`void`	`traceStackBetweenMatches(String from, String to, boolean includeClass)` print all stack frames between the frames which match start and end to System.out by calling traceStackBetweenMatches(from, to, includeClass, false)
`void`	`traceStackBetweenMatches(String from, String to, boolean includeClass, boolean includePackage)` print all stack frames between the frames which match start and end to System.out by calling traceStackBetweenMatches(from, to, includeClass, includePackage, null)
`void`	`traceStackBetweenMatches(String from, String to, boolean includeClass, boolean includePackage, String prefix)` print all stack frames between the frames which match start and end to System.out preceded by prefix by calling traceStackBetweenMatches(from, to, true, includeClass, includePackage, prefix, "out");
`void`	`traceStackBetweenMatches(String from, String to, boolean includeClass, boolean includePackage, String prefix, Object key)` print all stack frames between the frames which match start and end preceded by prefix by calling traceStackRange(from, to, true, includeClass, includePackage, prefix, key)
`void`	`traceStackBetweenMatches(String from, String to, boolean includeClass, String prefix)` print all stack frames between the frames which match start and end to System.out by calling traceStackBetweenMatches(from, to, includeClass, false, prefix)
`void`	`traceStackBetweenMatches(String from, String to, boolean includeClass, String prefix, Object key)` print all stack frames between the frames which match start and end preceded by prefix by calling traceStackBetween(from, to, includeClass, false, prefix, key)
`void`	`traceStackBetweenMatches(String from, String to, String prefix)` print all stack frames between the frames which match start and end to System.out preceded by prefix by calling traceStackBetweenMatches(from, to, prefix, "out")
`void`	`traceStackBetweenMatches(String from, String to, String prefix, Object key)` print all stack frames between the frames which match start and end to System.out preceded by prefix by calling traceStackBetweenMatches(from, to, false, prefix, key)
`void`	`traceStackMatching(String regExp)` print all stack frames which match pattern to System.out by calling traceStackMatching(pattern, null)
`void`	`traceStackMatching(String regExp, boolean includeClass)` print all stack frames which match pattern to System.out by calling traceStackMatching(pattern, includeClass, false)
`void`	`traceStackMatching(String regExp, boolean includeClass, boolean includePackage)` print all stack frames which match pattern to System.out by calling traceStackMatching(pattern, includeClass, includePackage, null)
`void`	`traceStackMatching(String regExp, boolean includeClass, boolean includePackage, String prefix)` print all stack frames which match pattern to System.out preceded by prefix by calling traceStackMatching(pattern, includeClass, , includePackage, prefix, "out")
`void`	`traceStackMatching(String regExp, boolean includeClass, boolean includePackage, String prefix, Object key)` print all stack frames which match pattern to the trace stream identified by key preceded by prefix.
`void`	`traceStackMatching(String regExp, boolean includeClass, String prefix)` print all stack frames which match pattern to System.out preceded by prefix by calling traceStackMatching(pattern, includeClass, false, prefix)
`void`	`traceStackMatching(String regExp, boolean includeClass, String prefix, Object key)` print all stack frames which match pattern to System.out preceded by prefix by calling traceStackMatching(pattern, includeClass, false, prefix, key)
`void`	`traceStackMatching(String regExp, String prefix)` print all stack frames which match pattern to System.out preceded by prefix by calling traceStackMatching(pattern, prefix, "out")
`void`	`traceStackMatching(String regExp, String prefix, Object key)` print all stack frames which match pattern to System.out preceded by prefix by calling traceStackMatching(pattern, false, prefix, key)
`void`	`traceStackRange(String from, String to, boolean isRegExp, boolean includeClass, boolean includePackage, String prefix, Object key)` print all stack frames between the frames which match start and end to the trace stream identified by key preceded by prefix.
`void`	`traceThreadStack(String threadName)` print a stack trace of a specific thread to System.out by calling traceThreadStack(threadName, null)
`void`	`traceThreadStack(String threadName, int maxFrames)` print a stack trace of a specific thread to System.out by calling traceThreadStack(threadName, null, maxFrames)
`void`	`traceThreadStack(String threadName, String prefix)` print a stack trace of a specific thread to System.out by calling traceThreadStack(threadName, prefix, "out")
`void`	`traceThreadStack(String threadName, String prefix, int maxFrames)` print a stack trace of a specific thread of a specific thread to System.out by calling traceThreadStack(threadName, prefix, "out", maxFrames)
`void`	`traceThreadStack(String threadName, String prefix, Object key)` print a stack trace of a specific thread to the trace stream identified by key by calling traceThreadStack(threadName, prefix, key, 0)
`void`	`traceThreadStack(String threadName, String prefix, Object key, int maxFrames)` print a stack trace to the trace stream identified by key
`protected int`	`triggerIndex(StackTraceElement[] stack)` return the index of the frame in stack for the trigger method below which the rule system was entered or -1 if it cannot be found
`static void`	`uninstalled(Rule rule)`
`void`	`waitFor(Object identifier)` wait for another thread to signal an event with no timeout.
`void`	`waitFor(Object identifier, long millisecs)` wait for another thread to signal an event with a specific timeout or no timeout if zero is supplied as the second argument.
`boolean`	`waiting(Object identifier)` test if there are threads waiting for an event identified by the supplied object to be signalled

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

- Field Detail
  - rule
```
protected Rule rule
```
- Constructor Detail
  - Helper
```
protected Helper(Rule rule)
```
- Method Detail
  - debug
```
public boolean debug(String text)
```
    builtin to print a message during rule execution. n.b. this always returns true which means it can be invoked during condition execution
    
    Parameters:
    text - the message to be printed as trace output
    
    Returns:
    true
  - traceOpen
```
public boolean traceOpen(Object identifier)
```
    open a trace output stream identified by identifier to a file located in the current working directory using a unique generated name
    
    Parameters:
    identifier - an identifier used subsequently to identify the trace output stream
    
    Returns:
    true if new file and stream was created, false if a stream identified by identifier already existed or the identifer is null, "out" or "err"
  - traceOpen
```
public boolean traceOpen(Object identifier,
                String fileName)
```
    open a trace output stream identified by identifier to a file located in the current working directory using the given file name or a generated name if the supplied name is null
    
    Parameters:
    identifier - an identifier used subsequently to identify the trace output stream
    
    Returns:
    true if new file and stream was created, false if a stream identified by identifier already existed or if a file of the same name already exists or the identifer is null, "out" or "err"
  - traceClose
```
public boolean traceClose(Object identifier)
```
    close the trace output stream identified by identifier flushing any pending output
    
    Parameters:
    identifier - an identifier used subsequently to identify the trace output stream
    
    Returns:
    true if the stream was flushed and closed, false if no stream is identified by identifier or the identifer is null, "out" or "err"
  - trace
```
public boolean trace(String message)
```
    call trace("out, message").
    
    Parameters:
    message -
    
    Returns:
    true
  - trace
```
public boolean trace(Object identifier,
            String message)
```
    write the supplied message to the trace stream identified by identifier, creating a new stream if none exists
    
    Parameters:
    identifier - an identifier used subsequently to identify the trace output stream
    message -
    
    Returns:
    true
  - traceln
```
public boolean traceln(String message)
```
    call traceln("out", message).
    
    Parameters:
    message -
    
    Returns:
    true
  - traceln
```
public boolean traceln(Object identifier,
              String message)
```
    write the supplied message to the trace stream identified by identifier, creating a new stream if none exists, and append a new line
    
    Parameters:
    identifier - an identifier used subsequently to identify the trace output stream
    message -
    
    Returns:
    true
  - openTrace
```
public boolean openTrace(Object identifier)
```
    version for backwards compatibility -- docs and original code were mismatched
  - openTrace
```
public boolean openTrace(Object identifier,
                String fileName)
```
    version for backwards compatibility -- docs and original code were mismatched
  - closeTrace
```
public boolean closeTrace(Object identifier)
```
    version for backwards compatibility -- docs and original code were mismatched
  - flag
```
public boolean flag(Object identifier)
```
    set a flag keyed by the supplied object if it is not already set
    
    Parameters:
    identifier - the object identifying the relevant flag
    
    Returns:
    true if the flag was clear before this call otherwise false
  - flagged
```
public boolean flagged(Object identifier)
```
    test the state of the flag keyed by the supplied object
    
    Parameters:
    identifier - the object identifying the relevant flag
    
    Returns:
    true if the flag is set otherwise false
  - clear
```
public boolean clear(Object identifier)
```
    clear the flag keyed by the supplied object if it is not already clear
    
    Parameters:
    identifier - the object identifying the relevant flag
    
    Returns:
    true if the flag was clear before this call otherwise false
  - getCountDown
```
public boolean getCountDown(Object identifier)
```
    for backwards compatibility
  - isCountDown
```
public boolean isCountDown(Object identifier)
```
    builtin to test test if a countdown has been installed
    
    Parameters:
    identifier - an object which uniquely identifies the countdown in question
    
    Returns:
    true if the countdown is currently installed
  - addCountDown
```
public boolean addCountDown(Object identifier,
                   int count)
```
    alias for createCountDown provided for backwards compatibility
  - createCountDown
```
public boolean createCountDown(Object identifier,
                      int count)
```
    builtin to test create a countdown identified by a specific object and with the specified count. n.b. this builtin checks if a countdown identified by the supplied object is currently installed, returning false if so, otherwise atomically adds the countdown and returns true. This allows the builtin to be used safely in conditions where concurrent rule firings (including firings of multiple rules) might otherwise lead to a race condition.
    
    Parameters:
    identifier - an object which uniquely identifies the countdown in question
    count - the number of times the countdown needs to be counted down before the countdown operation returns true. e.g. if count is supplied as 2 then the first two calls to countDown(Object) will return false and the third call will return true.
    
    Returns:
    true if a new countdown is installed, false if one already exists.
  - countDown
```
public boolean countDown(Object identifier)
```
    builtin to decrement the countdown identified by a specific object, uninstalling it and returning true only when the count is zero.
    
    Parameters:
    identifier - an object which uniquely identifies the countdown in question
    
    Returns:
    true if the countdown is installed and its count is zero, otherwise false
  - waiting
```
public boolean waiting(Object identifier)
```
    test if there are threads waiting for an event identified by the supplied object to be signalled
    
    Parameters:
    identifier - an object identifying the event to be signalled
    
    Returns:
    true if threads are waiting for the associated event to be signalled
  - waitFor
```
public void waitFor(Object identifier)
```
    wait for another thread to signal an event with no timeout. see waitFor(Object, long) for details and caveats regarding calling this builtin.
    
    Parameters:
    identifier - an object used to identify the signal that is to be waited on.
  - waitFor
```
public void waitFor(Object identifier,
           long millisecs)
```
    wait for another thread to signal an event with a specific timeout or no timeout if zero is supplied as the second argument. this may be called in a rule event, condition or action. it will suspend the current thread pending signalling of the event at which point rule processing will either continue or abort depending upon the type of signal. if an exception is thrown it will be an instance of runtime exception which, in normal circumstances, will cause the thread to exit. The exception may not kill the thread f the trigger method or calling code contains a catch-all handler so care must be used to ensure that an abort of waiting threads has the desired effect. n.b. care must also be employed if the current thread is inside a synchronized block since there is a potential for the waitFor call to cause deadlock.
    
    Parameters:
    identifier - an object used to identify the signal that is to be waited on. n.b. the wait operation is not performed using synchronization on the supplied object as the rule system cannot safely release and reobtain locks on application data. this argument is used as a key to identify a synchronization object private to the rule system.
  - signalWake
```
public boolean signalWake(Object identifier)
```
    call signalWake(Object, boolean) defaulting the second argument to false
  - signalWake
```
public boolean signalWake(Object identifier,
                 boolean mustMeet)
```
    signal an event identified by the supplied object, causing all waiting threads to resume rule processing and clearing the event. if there are no threads waiting either because there has been no call to waitFor(java.lang.Object) or because some other thread has sent the signal then this call returns false, otherwise it returns true. This operation is atomic, allowing the builtin to be used in rule conditions.
    
    Parameters:
    identifier - an object used to identify the which waiting threads the signal should be delivered to. n.b. the operation is not performed using a notify on the supplied object. this argument is used as a key to identify a synchronization object private to the rule system.
    mustMeet - if true then the signal operation must not be delivered until some other thread is actually waiting on a waiter identified by identifier. if there is no such waiter when this method is called then the calling thread will suspend until one arrives.
  - signalKill
```
public boolean signalKill(Object identifier)
```
    for backwards compatibility
  - signalKill
```
public boolean signalKill(Object identifier,
                 boolean mustMeet)
```
    for backwards compatibility
  - signalThrow
```
public boolean signalThrow(Object identifier)
```
    call signalThrow(Object, boolean) defaulting the second argument to false
  - signalThrow
```
public boolean signalThrow(Object identifier,
                  boolean mustMeet)
```
    signal an event identified by the suppied object, causing all waiting threads to throw an exception and clearing the event. if there are no objects waiting, either because there has been no call to waitFor(java.lang.Object) or because some other thread has already sent the signal, then this call returns false, otherwise it returns true. This operation is atomic, allowing the builtin to be used safely in rule conditions.
    
    Parameters:
    identifier - an object used to identify the which waiting threads the signal should be delivered to. n.b. the operation is not performed using a notify on the supplied object. this argument is used as a key to identify a synchronization object private to the rule system.
    mustMeet - if true then the signal operation must not be delivered until some other thread is actually waiting on a waiter identified by identifier. if there is no such waiter when this method is called then the calling thread will suspend until one arrives.
  - delay
```
public void delay(long millisecs)
```
    delay execution of the current thread for a specified number of milliseconds
    
    Parameters:
    millisecs - how many milliseconds to delay for
  - createRendezvous
```
public boolean createRendezvous(Object identifier,
                       int expected)
```
    call createRendezvous(Object, int, boolean) supplying false for the last parameter
    
    Parameters:
    identifier - an identifier for the rendezvous
    expected - the number of threads expected to meet at the rendezvous
    
    Returns:
    true if the rendezvous is created or false if a rendezvous identified by identifier already exists
  - createRendezvous
```
public boolean createRendezvous(Object identifier,
                       int expected,
                       boolean restartable)
```
    create a rendezvous for a given number of threads to join
    
    Parameters:
    identifier - an identifier for the rendezvious in subsequent rendezvous operations
    expected -
    restartable -
    
    Returns:
  - isRendezvous
```
public boolean isRendezvous(Object identifier,
                   int expected)
```
    test whether a rendezvous with a specific expected count is associated with identifier
    
    Parameters:
    identifier - the identifier for the rendezvous
    expected - the number of threads expected to meet at the rendezvous
    
    Returns:
    true if the endezvous exists and is active otherwise false
  - getRendezvous
```
public int getRendezvous(Object identifier,
                int expected)
```
    test whether a rendezvous with a specific expected count is associated with identifier
    
    Parameters:
    identifier - the identifier for the rendezvous
    expected - the number of threads expected to meet at the rendezvous
    
    Returns:
    the numer of threads currently arrived at the rendezvous
  - rendezvous
```
public int rendezvous(Object identifier)
```
    meet other threads at a given rendezvous returning only when the expected number have arrived
    
    Parameters:
    identifier - the identifier for the rendezvous
    
    Returns:
    an ordinal which sorts all parties to the rendezvous in order of arrival from 0 to (expected-1) or -1 if the rendezvous does not exist
  - deleteRendezvous
```
public boolean deleteRendezvous(Object identifier,
                       int expected)
```
  - createJoin
```
public boolean createJoin(Object key,
                 int max)
```
  - isJoin
```
public boolean isJoin(Object key,
             int max)
```
  - joinEnlist
```
public boolean joinEnlist(Object key)
```
  - joinWait
```
public boolean joinWait(Object key,
               int count)
```
  - createCounter
```
public boolean createCounter(Object o)
```
    create a counter identified by the given object with count 0 as its initial count
    
    Parameters:
    o - an identifier used to refer to the counter in future
    
    Returns:
    true if a new counter was created and false if one already existed under the given identifier
  - createCounter
```
public boolean createCounter(Object o,
                    int value)
```
    create a counter identified by the given object with the supplied value as its iniital count
    
    Parameters:
    o - an identifier used to refer to the counter in future
    value - the initial value for the counter
    
    Returns:
    true if a new counter was created and false if one already existed under the given identifier
  - deleteCounter
```
public boolean deleteCounter(Object o)
```
    delete a counter identified by the given object with count 0 as its initial count
    
    Parameters:
    o - the identifier for the coounter
    
    Returns:
    true if a counter was deleted and false if no counter existed under the given identifier
  - readCounter
```
public int readCounter(Object o)
```
    read the value of the counter associated with given identifier, creating a new one with count zero if none exists
    
    Parameters:
    o - the identifier for the counter
    
    Returns:
    the value of the counter
  - readCounter
```
public int readCounter(Object o,
              boolean zero)
```
    read and optionally reset to zero the value of the counter associated with given identifier, creating a new one with count zero if none exists
    
    Parameters:
    o - the identifier for the counter
    zero - if true then zero the counter
    
    Returns:
    the value of the counter
  - incrementCounter
```
public int incrementCounter(Object o)
```
    increment the value of the counter associated with given identifier, creating a new one with count zero if none exists
    
    Parameters:
    o - the identifier for the counter
    
    Returns:
    the value of the counter after the increment
  - decrementCounter
```
public int decrementCounter(Object o)
```
    decrement the value of the counter associated with given identifier, creating a new one with count zero if none exists
    
    Parameters:
    o - the identifier for the counter
    
    Returns:
    the value of the counter after the decrement
  - incrementCounter
```
public int incrementCounter(Object o,
                   int amount)
```
    increment the value of the counter associated with given identifier by the given amount, creating a new one with count zero if none exists
    
    Parameters:
    o - the identifier for the counter
    amount - the amount to add to the counter
    
    Returns:
    the value of the counter after the increment
  - createTimer
```
public boolean createTimer(Object o)
```
    create a timer identified by the given object
    
    Parameters:
    o - an identifier used to refer to the timer in future
    
    Returns:
    true if a new timer was created and false if one already existed under the given identifier
  - deleteTimer
```
public boolean deleteTimer(Object o)
```
    delete a timer identified by the given object
    
    Parameters:
    o - the identifier for the timer
    
    Returns:
    true if a timer was deleted and false if no timer existed under the given identifier
  - getElapsedTimeFromTimer
```
public long getElapsedTimeFromTimer(Object o)
```
    get the elapsed time from the start (or last reset) of timer associated with given identifier, creating a new one if none exists
    
    Parameters:
    o - the identifier for the timer
    
    Returns:
    the elapsed time since the start (or reset) of the timer
  - resetTimer
```
public long resetTimer(Object o)
```
    reset the timer associated with given identifier, creating a new one if none exists
    
    Parameters:
    o - the identifier for the timer
    
    Returns:
    the current elapsed value of the timer before the reset
  - killThread
```
public void killThread()
```
    cause the current thread to throw a runtime exception which will normally cause it to exit. The exception may not kill the thread if the trigger method or calling code contains a catch-all handler so care must be employed to ensure that a call to this builtin has the desired effect.
  - killJVM
```
public void killJVM()
```
    cause the current JVM to halt immediately, simulating a crash as near as possible. exit code -1 is returned
  - killJVM
```
public void killJVM(int exitCode)
```
    cause the current JVM to halt immediately, simulating a crash as near as possible. exit code -1 is returned
  - callerEquals
```
public boolean callerEquals(String name)
```
    test whether the name of the method which called the the trigger method matches the supplied name by calling callerEquals(name, false)
    
    Returns:
    true if the name of the method which called the the trigger method matches the supplied name otherwise false
  - callerEquals
```
public boolean callerEquals(String name,
                   int frameCount)
```
    test whether the name of any of the selected methods in the stack which called the trigger method matches the supplied name by calling callerEquals(name, 1, frameCount)
    
    Returns:
    true if the name of the method which called the the trigger method matches the supplied name otherwise false
  - callerEquals
```
public boolean callerEquals(String name,
                   int startFrame,
                   int frameCount)
```
    test whether the name of any of the selected methods in the stack which called the trigger method matches the supplied name by calling callerEquals(name, false, startFrame, frameCount)
    
    Returns:
    true if the name of the method which called the the trigger method matches the supplied name otherwise false
  - callerEquals
```
public boolean callerEquals(String name,
                   boolean includeClass)
```
    test whether the name of method which called the the trigger method matches the supplied name by calling callerEquals(name, includeClass, false)
    
    Returns:
    true if the name of the method which called the the trigger method matches the supplied name otherwise false
  - callerEquals
```
public boolean callerEquals(String name,
                   boolean includeClass,
                   int frameCount)
```
    test whether the name of method which called the the trigger method matches the supplied name by calling callerEquals(name, includeClass, false, frameCount)
    
    Returns:
    true if the name of the method which called the the trigger method matches the supplied name otherwise false
  - callerEquals
```
public boolean callerEquals(String name,
                   boolean includeClass,
                   int startFrame,
                   int frameCount)
```
    test whether the name of method which called the the trigger method matches the supplied name by calling callerEquals(name, includeClass, false, startFrame, frameCount)
    
    Returns:
    true if the name of the method which called the the trigger method matches the supplied name otherwise false
  - callerEquals
```
public boolean callerEquals(String name,
                   boolean includeClass,
                   boolean includePackage)
```
    test whether the name of method which called the the trigger method matches the supplied name by calling callerEquals(name, includeClass, includePackage, 1)
    
    Returns:
    true if the name of the method which called the the trigger method matches the supplied name otherwise false
  - callerEquals
```
public boolean callerEquals(String name,
                   boolean includeClass,
                   boolean includePackage,
                   int frameCount)
```
    test whether the name of any of the selected methods in the stack which called the trigger method matches the supplied name by calling callerCheck(name, false, includeClass, includePackage, 1, frameCount)
    
    Returns:
    true if the name of the method which called the the trigger method matches the supplied name otherwise false
  - callerEquals
```
public boolean callerEquals(String name,
                   boolean includeClass,
                   boolean includePackage,
                   int startFrame,
                   int frameCount)
```
    test whether the name of any of the selected methods in the stack which called the trigger method matches the supplied name by calling callerCheck(name, false, includeClass, false, startFrame, frameCount)
    
    Returns:
    true if the name of the method which called the the trigger method matches the supplied name otherwise false
  - callerMatches
```
public boolean callerMatches(String regExp)
```
    test whether the name of the method which called the the trigger method matches the supplied regular by calling callerMatches(regExp, false)
    
    Returns:
    true if the name of the method which called the the trigger method matches the supplied regular expression otherwise false
  - callerMatches
```
public boolean callerMatches(String regExp,
                    int frameCount)
```
    test whether the name of any of the selected methods in the stack which called the trigger method matches the supplied regular expression by calling callerMatches(regExp, 1, frameCount)
    
    Returns:
    true if the name of the method which called the the trigger method matches the supplied regular expression otherwise false
  - callerMatches
```
public boolean callerMatches(String regExp,
                    int startFrame,
                    int frameCount)
```
    test whether the name of any of the selected methods in the stack which called the trigger method matches the supplied regular expression by calling callerMatches(regExp, false, startFrame, frameCount)
    
    Returns:
    true if the name of the method which called the the trigger method matches the supplied regular expression otherwise false
  - callerMatches
```
public boolean callerMatches(String regExp,
                    boolean includeClass)
```
    test whether the name of method which called the the trigger method matches the supplied regular expression by calling callerMatches(regExp, includeClass, false)
    
    Returns:
    true if the name of the method which called the the trigger method matches the supplied regular expression otherwise false
  - callerMatches
```
public boolean callerMatches(String regExp,
                    boolean includeClass,
                    int frameCount)
```
    test whether the name of method which called the the trigger method matches the supplied regular expression by calling callerMatches(regExp, includeClass, false, frameCount)
    
    Returns:
    true if the name of the method which called the the trigger method matches the supplied regular expression otherwise false
  - callerMatches
```
public boolean callerMatches(String regExp,
                    boolean includeClass,
                    int startFrame,
                    int frameCount)
```
    test whether the name of method which called the the trigger method matches the supplied regular expression by calling callerMatches(regExp, includeClass, false, startFrame, frameCount)
    
    Returns:
    true if the name of the method which called the the trigger method matches the supplied regular expression otherwise false
  - callerMatches
```
public boolean callerMatches(String regExp,
                    boolean includeClass,
                    boolean includePackage)
```
    test whether the name of method which called the the trigger method matches the supplied regular expression by calling callerMatches(regExp, includeClass, includePackage, 1)
    
    Returns:
    true if the name of the method which called the the trigger method matches the supplied regular expression otherwise false
  - callerMatches
```
public boolean callerMatches(String regExp,
                    boolean includeClass,
                    boolean includePackage,
                    int frameCount)
```
    test whether the name of method which called the the trigger method matches the supplied regular expression by calling callerMatches(regExp, includeClass, includePackage, 1, frameCount)
    
    Returns:
    true if the name of the method which called the the trigger method matches the supplied regular expression otherwise false
  - callerMatches
```
public boolean callerMatches(String regExp,
                    boolean includeClass,
                    boolean includePackage,
                    int startFrame,
                    int frameCount)
```
    test whether the name of any of the selected methods in the stack which called the trigger method matches the supplied regular expression by calling callerCheck(regExp, true, includeClass, includePackage, 1, frameCount)
    
    Returns:
    true if the name of the method which called the the trigger method matches the supplied regular expression otherwise false
  - callerCheck
```
public boolean callerCheck(String match,
                  boolean isRegExp,
                  boolean includeClass,
                  boolean includePackage,
                  int startFrame,
                  int frameCount)
```
    test whether the name of any of the selected methods in the stack which called the trigger method matches the supplied regular expression.
    
    Parameters:
    match - an expression which will be matched against the name of the method which called the trigger method
    isRegExp - true if match should be matched as a regular expression and false if it should be matched using a String equals comparison.
    includeClass - true if the match should be against the class qualified method name
    includePackage - true if the match should be against the package and class qualified method name. ignored if includeClass is not also true.
    startFrame - identifies the first frame which frame which should be considered. 0 identifies the trigger frame, 1 the frame for the caller of the trigger method etc. If startFrame is negative false is returned.
    frameCount - counts the frames which should be checked starting from the first caller. if this is non-positive or exceeds the actual number of callers above the start frame then all frames in the stack are tested.
    
    Returns:
    true if the name of one of the selected methods in the call stack starting from the trigger method matches the supplied match value otherwise false
  - traceStack
```
public void traceStack()
```
    print a stack trace to System.out by calling traceStack(null)
  - traceStack
```
public void traceStack(String prefix)
```
    print a stack trace to System.out by calling traceStack(prefix, "out")
  - traceStack
```
public void traceStack(String prefix,
              Object key)
```
    print a stack trace to the trace stream identified by key by calling traceStack(prefix, key, 0)
  - traceStack
```
public void traceStack(int maxFrames)
```
    print a stack trace to System.out by calling traceStack(null, maxFrames)
  - traceStack
```
public void traceStack(String prefix,
              int maxFrames)
```
    print a stack trace to System.out by calling traceStack(prefix, "out", maxFrames)
  - traceStack
```
public void traceStack(String prefix,
              Object key,
              int maxFrames)
```
    print a stack trace to the trace stream identified by key
    
    Parameters:
    prefix - a String to be printed once before printing each line of stack trace. if supplied as null then the prefix "Stack trace for thread " + Thread.currentThread().getName() + "\n" is used
    key - an object identifying the trace stream to which output should be generated
    maxFrames - the maximum number of frames to print or 0 if no limit should apply
  - traceAllStacks
```
public void traceAllStacks()
```
    print trace of all threads' stacks to System.out by calling traceAllStacks(null)
  - traceAllStacks
```
public void traceAllStacks(String prefix)
```
    print trace of all threads' stacks to System.out by calling traceAllStacks(prefix, "out")
  - traceAllStacks
```
public void traceAllStacks(String prefix,
                  Object key)
```
    print trace of all threads' stacks to the trace stream identified by key by calling traceAllStacks(prefix, key, 0)
  - traceAllStacks
```
public void traceAllStacks(int maxFrames)
```
    print trace of all threads' stacks to System.out by calling traceAllStacks(null, maxFrames)
  - traceAllStacks
```
public void traceAllStacks(String prefix,
                  int maxFrames)
```
    print trace of all threads' stacks to System.out by calling traceAllStacks(prefix, "out", maxFrames)
  - traceAllStacks
```
public void traceAllStacks(String prefix,
                  Object key,
                  int maxFrames)
```
    print trace of all threads' stacks to the trace stream identified by key
    
    Parameters:
    prefix - a String to be printed once before printing each line of stack trace. if supplied as null then the prefix "Stack trace for thread " + Thread.currentThread().getName() + "\n" is used
    key - an object identifying the trace stream to which output should be generated
    maxFrames - the maximum number of frames to print or 0 if no limit should apply
  - traceThreadStack
```
public void traceThreadStack(String threadName)
```
    print a stack trace of a specific thread to System.out by calling traceThreadStack(threadName, null)
  - traceThreadStack
```
public void traceThreadStack(String threadName,
                    String prefix)
```
    print a stack trace of a specific thread to System.out by calling traceThreadStack(threadName, prefix, "out")
  - traceThreadStack
```
public void traceThreadStack(String threadName,
                    String prefix,
                    Object key)
```
    print a stack trace of a specific thread to the trace stream identified by key by calling traceThreadStack(threadName, prefix, key, 0)
  - traceThreadStack
```
public void traceThreadStack(String threadName,
                    int maxFrames)
```
    print a stack trace of a specific thread to System.out by calling traceThreadStack(threadName, null, maxFrames)
  - traceThreadStack
```
public void traceThreadStack(String threadName,
                    String prefix,
                    int maxFrames)
```
    print a stack trace of a specific thread of a specific thread to System.out by calling traceThreadStack(threadName, prefix, "out", maxFrames)
  - traceThreadStack
```
public void traceThreadStack(String threadName,
                    String prefix,
                    Object key,
                    int maxFrames)
```
    print a stack trace to the trace stream identified by key
    
    Parameters:
    prefix - a String to be printed once before printing each line of stack trace. if supplied as null then the prefix "Stack trace for thread " + threadName + "\n" is used
    key - an object identifying the trace stream to which output should be generated
    maxFrames - the maximum number of frames to print or 0 if no limit should apply
  - traceStackMatching
```
public void traceStackMatching(String regExp)
```
    print all stack frames which match pattern to System.out by calling traceStackMatching(pattern, null)
  - traceStackMatching
```
public void traceStackMatching(String regExp,
                      String prefix)
```
    print all stack frames which match pattern to System.out preceded by prefix by calling traceStackMatching(pattern, prefix, "out")
  - traceStackMatching
```
public void traceStackMatching(String regExp,
                      String prefix,
                      Object key)
```
    print all stack frames which match pattern to System.out preceded by prefix by calling traceStackMatching(pattern, false, prefix, key)
  - traceStackMatching
```
public void traceStackMatching(String regExp,
                      boolean includeClass)
```
    print all stack frames which match pattern to System.out by calling traceStackMatching(pattern, includeClass, false)
  - traceStackMatching
```
public void traceStackMatching(String regExp,
                      boolean includeClass,
                      String prefix)
```
    print all stack frames which match pattern to System.out preceded by prefix by calling traceStackMatching(pattern, includeClass, false, prefix)
  - traceStackMatching
```
public void traceStackMatching(String regExp,
                      boolean includeClass,
                      String prefix,
                      Object key)
```
    print all stack frames which match pattern to System.out preceded by prefix by calling traceStackMatching(pattern, includeClass, false, prefix, key)
  - traceStackMatching
```
public void traceStackMatching(String regExp,
                      boolean includeClass,
                      boolean includePackage)
```
    print all stack frames which match pattern to System.out by calling traceStackMatching(pattern, includeClass, includePackage, null)
  - traceStackMatching
```
public void traceStackMatching(String regExp,
                      boolean includeClass,
                      boolean includePackage,
                      String prefix)
```
    print all stack frames which match pattern to System.out preceded by prefix by calling traceStackMatching(pattern, includeClass, , includePackage, prefix, "out")
  - traceStackMatching
```
public void traceStackMatching(String regExp,
                      boolean includeClass,
                      boolean includePackage,
                      String prefix,
                      Object key)
```
    print all stack frames which match pattern to the trace stream identified by key preceded by prefix.
    
    Parameters:
    regExp - a pattern which will be matched against the method name of the stack frame as a regular expression by calling String.matches()
    includeClass - true if the match should be against the package and class qualified method name
    includePackage - true if the match should be against the package and class qualified method name. ignored if includeClass is not also true.
    prefix - a String to be printed once before printing each line of stack trace. if supplied as null then the prefix "Stack trace for thread " + Thread.currentThread().getName() + " matching " + pattern + "\n" is used
    key - an object identifying the trace stream to which output should be generated
  - traceStackBetween
```
public void traceStackBetween(String from,
                     String to)
```
    print all stack frames between the frames which match start and end to System.out by calling traceStackBetween(from, to, null)
  - traceStackBetween
```
public void traceStackBetween(String from,
                     String to,
                     String prefix)
```
    print all stack frames between the frames which match start and end to System.out preceded by prefix by calling traceStackBetween(from, to, prefix, "out")
  - traceStackBetween
```
public void traceStackBetween(String from,
                     String to,
                     String prefix,
                     Object key)
```
    print all stack frames between the frames which match start and end preceded by prefix by calling traceStackBetween(from, to, false, prefix, key)
  - traceStackBetween
```
public void traceStackBetween(String from,
                     String to,
                     boolean includeClass)
```
    print all stack frames between the frames which match start and end to System.out by calling traceStackBetween(from, to, includeClass, false)
  - traceStackBetween
```
public void traceStackBetween(String from,
                     String to,
                     boolean includeClass,
                     String prefix)
```
    print all stack frames between the frames which match start and end to System.out by calling traceStackBetween(from, to, includeClass, false, prefix)
  - traceStackBetween
```
public void traceStackBetween(String from,
                     String to,
                     boolean includeClass,
                     String prefix,
                     Object key)
```
    print all stack frames between the frames which match start and end preceded by prefix by calling traceStackBetween(from, to, includeClass, false, prefix, key)
  - traceStackBetween
```
public void traceStackBetween(String from,
                     String to,
                     boolean includeClass,
                     boolean includePackage)
```
    print all stack frames between the frames which match start and end to System.out by calling traceStackBetween(from, to, includeClass, includePackage, null)
  - traceStackBetween
```
public void traceStackBetween(String from,
                     String to,
                     boolean includeClass,
                     boolean includePackage,
                     String prefix)
```
    print all stack frames between the frames which match start and end to System.out preceded by prefix by calling traceStackBetween(from, to, includeClass, includePackage, prefix, "out")
  - traceStackBetween
```
public void traceStackBetween(String from,
                     String to,
                     boolean includeClass,
                     boolean includePackage,
                     String prefix,
                     Object key)
```
    print all stack frames between the frames which match start and end preceded by prefix by calling traceStackBetween(from, to, false, includeClass, includePackage, prefix, key)
  - traceStackBetweenMatches
```
public void traceStackBetweenMatches(String from,
                            String to)
```
    print all stack frames between the frames which match start and end to System.out by calling traceStackBetweenMatches(from, to, null)
  - traceStackBetweenMatches
```
public void traceStackBetweenMatches(String from,
                            String to,
                            String prefix)
```
    print all stack frames between the frames which match start and end to System.out preceded by prefix by calling traceStackBetweenMatches(from, to, prefix, "out")
  - traceStackBetweenMatches
```
public void traceStackBetweenMatches(String from,
                            String to,
                            String prefix,
                            Object key)
```
    print all stack frames between the frames which match start and end to System.out preceded by prefix by calling traceStackBetweenMatches(from, to, false, prefix, key)
  - traceStackBetweenMatches
```
public void traceStackBetweenMatches(String from,
                            String to,
                            boolean includeClass)
```
    print all stack frames between the frames which match start and end to System.out by calling traceStackBetweenMatches(from, to, includeClass, false)
  - traceStackBetweenMatches
```
public void traceStackBetweenMatches(String from,
                            String to,
                            boolean includeClass,
                            String prefix)
```
    print all stack frames between the frames which match start and end to System.out by calling traceStackBetweenMatches(from, to, includeClass, false, prefix)
  - traceStackBetweenMatches
```
public void traceStackBetweenMatches(String from,
                            String to,
                            boolean includeClass,
                            String prefix,
                            Object key)
```
    print all stack frames between the frames which match start and end preceded by prefix by calling traceStackBetween(from, to, includeClass, false, prefix, key)
  - traceStackBetweenMatches
```
public void traceStackBetweenMatches(String from,
                            String to,
                            boolean includeClass,
                            boolean includePackage)
```
    print all stack frames between the frames which match start and end to System.out by calling traceStackBetweenMatches(from, to, includeClass, includePackage, null)
  - traceStackBetweenMatches
```
public void traceStackBetweenMatches(String from,
                            String to,
                            boolean includeClass,
                            boolean includePackage,
                            String prefix)
```
    print all stack frames between the frames which match start and end to System.out preceded by prefix by calling traceStackBetweenMatches(from, to, true, includeClass, includePackage, prefix, "out");
  - traceStackBetweenMatches
```
public void traceStackBetweenMatches(String from,
                            String to,
                            boolean includeClass,
                            boolean includePackage,
                            String prefix,
                            Object key)
```
    print all stack frames between the frames which match start and end preceded by prefix by calling traceStackRange(from, to, true, includeClass, includePackage, prefix, key)
  - traceStackRange
```
public void traceStackRange(String from,
                   String to,
                   boolean isRegExp,
                   boolean includeClass,
                   boolean includePackage,
                   String prefix,
                   Object key)
```
    print all stack frames between the frames which match start and end to the trace stream identified by key preceded by prefix.
    
    Parameters:
    from - a pattern which identifies the first frame which should be printed. from will be matched against the name of each successive stack frame from the trigger methdo frame until a matching frame is found. If null is supplied then the trigger frame will be used as the first frame to print. If a non-null value is supplied and no match is found then no frames will be printed.
    to - a pattern which identifies the last frame which should be printed. to will be matched against the name of each successive stack frame following the first matched frame until a matching frame is found. If null is supplied or no match is found then the bottom frame will be used as the last frame to print.
    isRegExp - true if from and true should be matched as regular expressions or false if they should be matched using a String equals comparison.
    includeClass - true if the match should be against the package and class qualified method name
    includePackage - true if the match should be against the package and class qualified method name. ignored if includeClass is not also true.
    prefix - a String to be printed once before printing each line of stack trace. if supplied as null then the prefix "Stack trace (restricted) for " + Thread.currentThread().getName() + "\n" is used
    key - an object identifying the trace stream to which output should be generated
  - formatStack
```
public String formatStack()
```
    return a stack trace by calling formatStack(null)
  - formatStack
```
public String formatStack(String prefix)
```
    return a stack trace by calling formatStack(prefix, 0)
  - formatStack
```
public String formatStack(int maxFrames)
```
    return a stack trace by calling formatStack(null, maxFrames)
  - formatStack
```
public String formatStack(String prefix,
                 int maxFrames)
```
    print a stack trace to the trace stream identified by key
    
    Parameters:
    prefix - a String to be printed once before printing each line of stack trace. if supplied as null then the prefix "Stack trace for thread " + Thread.currentThread().getName() + "\n" is used
    maxFrames - the maximum number of frames to print or 0 if no limit should apply
  - formatAllStacks
```
public String formatAllStacks()
```
    return all stack traces by calling formatAllStacks(null)
  - formatAllStacks
```
public String formatAllStacks(String prefix)
```
    return all stack traces by calling formatAllStacks(prefix, 0)
  - formatAllStacks
```
public String formatAllStacks(int maxFrames)
```
    return all stack traces by calling formatAllStacks(null, maxFrames)
  - formatAllStacks
```
public String formatAllStacks(String prefix,
                     int maxFrames)
```
    return all stack traces
    
    Parameters:
    prefix - a String to be printed once before printing each line of stack trace. if supplied as null then the prefix "Stack trace for thread " + Thread.currentThread().getName() + "\n" is used
    maxFrames - the maximum number of frames to print or 0 if no limit should apply
  - formatThreadStack
```
public String formatThreadStack(String threadName)
```
    return stack traces of a specific thread by calling formatThreadStack(threadName, null)
  - formatThreadStack
```
public String formatThreadStack(String threadName,
                       String prefix)
```
    return all stack traces by calling formatThreadStack(threadName, prefix, 0)
  - formatThreadStack
```
public String formatThreadStack(String threadName,
                       int maxFrames)
```
    return all stack traces by calling formatThreadStack(threadName, null, maxFrames)
  - formatThreadStack
```
public String formatThreadStack(String threadName,
                       String prefix,
                       int maxFrames)
```
    return all stack traces
    
    Parameters:
    prefix - a String to be printed once before printing each line of stack trace. if supplied as null then the prefix "Stack trace for thread " + threadName + "\n" is used
    maxFrames - the maximum number of frames to print or 0 if no limit should apply
  - formatStackMatching
```
public String formatStackMatching(String regExp)
```
    return a String tracing all stack frames which match pattern by calling formatStackMatching(pattern, null)
  - formatStackMatching
```
public String formatStackMatching(String regExp,
                         String prefix)
```
    return a String tracing all stack frames which match pattern by calling formatStackMatching(pattern, false, prefix)
  - formatStackMatching
```
public String formatStackMatching(String regExp,
                         boolean includeClass)
```
    return a String tracing all stack frames which match pattern by calling formatStackMatching(pattern, includeClass, false)
  - formatStackMatching
```
public String formatStackMatching(String regExp,
                         boolean includeClass,
                         String prefix)
```
    return a String tracing all stack frames which match pattern by calling formatStackMatching(pattern, includeClass, false, prefix)
  - formatStackMatching
```
public String formatStackMatching(String regExp,
                         boolean includeClass,
                         boolean includePackage)
```
    return a String tracing all stack frames which match pattern by calling formatStackMatching(pattern, includeClass, includePackage, null)
  - formatStackMatching
```
public String formatStackMatching(String regExp,
                         boolean includeClass,
                         boolean includePackage,
                         String prefix)
```
    return a String tracing all stack frames which match pattern.
    
    Parameters:
    regExp - a pattern which will be matched against the method name of the stack frame as a regular expression by calling String.matches()
    includeClass - true if the match should be against the package and class qualified method name
    includePackage - true if the match should be against the package and class qualified method name. ignored if includeClass is not also true.
    prefix - a String to be printed once before printing each line of stack trace. if supplied as null then the prefix "Stack trace for thread " + Thread.currentThread().getName() + " matching " + pattern + "\n" is used
  - formatStackBetween
```
public String formatStackBetween(String from,
                        String to)
```
    return a String tracing the stack between the frames which match start and end by calling formatStackBetween(from, to, null)
  - formatStackBetween
```
public String formatStackBetween(String from,
                        String to,
                        String prefix)
```
    return a String tracing the stack between the frames which match start and end by calling formatStackBetween(from, to, false, false, false, prefix)
  - formatStackBetween
```
public String formatStackBetween(String from,
                        String to,
                        boolean includeClass)
```
    return a String tracing the stack between the frames which match start and end by calling formatStackBetween(from, to, includeClass, false)
  - formatStackBetween
```
public String formatStackBetween(String from,
                        String to,
                        boolean includeClass,
                        String prefix)
```
    return a String tracing the stack between the frames which match start and end by calling formatStackBetween(from, to, includeClass, false, prefix)
  - formatStackBetween
```
public String formatStackBetween(String from,
                        String to,
                        boolean includeClass,
                        boolean includePackage)
```
    return a String tracing the stack between the frames which match start and end by calling formatStackBetween(from, to, includeClass, includePackage, null)
  - formatStackBetween
```
public String formatStackBetween(String from,
                        String to,
                        boolean includeClass,
                        boolean includePackage,
                        String prefix)
```
    return a String tracing the stack between the frames which match start and end by calling formatStackRange(from, to, false, includeClass, includePackage, prefix)
  - formatStackBetweenMatches
```
public String formatStackBetweenMatches(String from,
                               String to)
```
    return a String tracing the stack between the frames which match start and end by calling formatStackBetweenMatches(from, to, null)
  - formatStackBetweenMatches
```
public String formatStackBetweenMatches(String from,
                               String to,
                               String prefix)
```
    return a String tracing the stack between the frames which match start and end by calling formatStackBetweenMatches(from, to, false, false, false, prefix)
  - formatStackBetweenMatches
```
public String formatStackBetweenMatches(String from,
                               String to,
                               boolean includeClass)
```
    return a String tracing the stack between the frames which match start and end by calling formatStackBetweenMatches(from, to, includeClass, false)
  - formatStackBetweenMatches
```
public String formatStackBetweenMatches(String from,
                               String to,
                               boolean includeClass,
                               String prefix)
```
    return a String tracing the stack between the frames which match start and end by calling formatStackBetweenMatches(from, to, includeClass, false, prefix)
  - formatStackBetweenMatches
```
public String formatStackBetweenMatches(String from,
                               String to,
                               boolean includeClass,
                               boolean includePackage)
```
    return a String tracing the stack between the frames which match start and end by calling formatStackBetweenMatches(from, to, includeClass, includePackage, null)
  - formatStackBetweenMatches
```
public String formatStackBetweenMatches(String from,
                               String to,
                               boolean includeClass,
                               boolean includePackage,
                               String prefix)
```
    return a String tracing the stack between the frames which match start and end by calling formatStackRange(from, to, true, includeClass, includePackage, prefix)
  - formatStackRange
```
public String formatStackRange(String from,
                      String to,
                      boolean isRegExp,
                      boolean includeClass,
                      boolean includePackage,
                      String prefix)
```
    return a String tracing the stack between the frames which match start and end.
    
    Parameters:
    from - a pattern which identifies the first frame which should be printed. from will be matched against the name of each successive stack frame from the trigger methdo frame until a matching frame is found. If null is supplied then the trigger frame will be used as the first frame to print. If a non-null value is supplied and no match is found then no frames will be printed.
    to - a pattern which identifies the last frame which should be printed. to will be matched against the name of each successive stack frame following the first matched frame until a matching frame is found. If null is supplied or no match is found then the bottom frame will be used as the last frame to print.
    isRegExp - true if from and true should be matched as regular expressions or false if they should be matched using a String equals comparison.
    includeClass - true if the match should be against the package and class qualified method name
    includePackage - true if the match should be against the package and class qualified method name. ignored if includeClass is not also true.
    prefix - a String to be printed once before printing each line of stack trace. if supplied as null then the prefix "Stack trace (restricted) for " + Thread.currentThread().getName() + "\n" is used
  - setTriggering
```
public void setTriggering(boolean enabled)
```
    enable or disable recursive triggering of rules by subsequent operations performed during binding, testing or firing of the current rule in the current thread.
    
    Parameters:
    enabled - true if triggering should be enabled or false if it should be disabled
  - getObjectSize
```
public long getObjectSize(Object o)
```
    provide an estimate of an object's size return -1 if not running in a real agent
  - toString
```
public String toString()
```
    return a unique name for the trigger point associated with this rule. n.b. a single rule may give rise to more than one trigger point if the rule applies to several methods with the same name or to several classes with the same (package unqualified) name, or even to several versions of the same compiled class loaded into distinct class loaders.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    a unique name for the trigger point from which this rule was invoked
  - activated
```
public static void activated()
```
  - deactivated
```
public static void deactivated()
```
  - installed
```
public static void installed(Rule rule)
```
  - uninstalled
```
public static void uninstalled(Rule rule)
```
  - getStack
```
protected StackTraceElement[] getStack()
```
    access to the current stack frames
    
    Returns:
  - triggerIndex
```
protected int triggerIndex(StackTraceElement[] stack)
```
    return the index of the frame in stack for the trigger method below which the rule system was entered or -1 if it cannot be found
    
    Returns:
    the index of the frame for the trigger method or -1 if it cannot be found
  - matchIndex
```
protected int matchIndex(StackTraceElement[] stack,
             String pattern,
             boolean isRegExp,
             boolean includeClass,
             boolean includePackage,
             int start,
             int limit)
```
    return the index of the first frame at or below index start which matches pattern
    
    Parameters:
    pattern - a pattern to be matched against the concatenated frame method name using String.matches()
    isRegExp - true if the pattern should be matched as a regular expression or false if it should be matched using a String equals comparison
    includeClass - true if the method name should be qualified with the package and class name
    start - the index of the first frame which should be tested for a match. this must be greater than or equal to the trigger index.
    limit - the index of the first frame which should not be tested for a match. this must be less than or equal to the stack length
    
    Returns:
    the index of the matching frame between start and limit - 1 or -1 if it no match found
  - printlnFrame
```
protected void printlnFrame(StringBuffer buffer,
                StackTraceElement frame)
```
    print the details of stack frame followed by a newline to buffer by calling printlnFrame(buffer, frame) then buffer.append('\n')
    
    Parameters:
    buffer -
    frame -
  - printFrame
```
protected void printFrame(StringBuffer buffer,
              StackTraceElement frame)
```
    print the details of stack frame to buffer
    
    Parameters:
    buffer -
    frame -

Class Helper

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

rule

Constructor Detail

Helper

Method Detail

debug

traceOpen

traceOpen

traceClose

trace

trace

traceln

traceln

openTrace

openTrace

closeTrace

flag

flagged

clear

getCountDown

isCountDown

addCountDown

createCountDown

countDown

waiting

waitFor

waitFor

signalWake

signalWake

signalKill

signalKill

signalThrow

signalThrow

delay

createRendezvous

createRendezvous

isRendezvous

getRendezvous

rendezvous

deleteRendezvous

createJoin

isJoin

joinEnlist

joinWait

createCounter

createCounter

deleteCounter

readCounter

readCounter

incrementCounter

decrementCounter

incrementCounter

createTimer

deleteTimer

getElapsedTimeFromTimer

resetTimer

killThread

killJVM

killJVM

callerEquals

callerEquals

callerEquals

callerEquals

callerEquals

callerEquals

callerEquals

callerEquals

callerEquals

callerMatches

callerMatches

callerMatches

callerMatches

callerMatches

callerMatches

callerMatches