Rule (byteman-root 2.0.4 API)

java.lang.Object
- org.jboss.byteman.rule.Rule

```
public class Rule
extends Object
```
A rule ties together an event, condition and action. It also maintains a TypeGroup identifying type information derived from these components.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`addAccessibleField(Field field)`
`int`	`addAccessibleMethod(Method method)`
`void`	`compile()` install helper class used to execute this rule.
`static Rule`	`create(RuleScript ruleScript, ClassLoader loader, HelperManager helperManager)`
`static boolean`	`disableTriggers()` disable triggering of rules inside the current thread.
`static boolean`	`disableTriggersInternal()` disable triggering of rules inside the current thread.
`static boolean`	`enableTriggers()` enable triggering of rules inside the current thread.
`static boolean`	`enableTriggersInternal()` enable triggering of rules inside the current thread n.b.
`static void`	`execute(String key, Object recipient, Object[] args)` forward an execute request a rule identified by its unique key
`Object`	`getAccessibleField(Object owner, int fieldIndex)`
`Action`	`getAction()`
`Bindings`	`getBindings()`
`Condition`	`getCondition()`
`Event`	`getEvent()`
`String`	`getFile()` retrieve the name of the file containing this rule
`Class`	`getHelperClass()` a getter allowing the helper class for the rule to be identified
`String`	`getKey()` called when a trigger is compiled for the rule to provide a String key which can be used at execution time to obtain a handle on the rule instance
`int`	`getLine()` retrieve the start line for the rule
`ClassLoader`	`getLoader()` get the class loader of the target class for the rule
`String`	`getName()`
`Type`	`getReturnType()`
`String`	`getTargetClass()`
`Location`	`getTargetLocation()`
`String`	`getTargetMethod()`
`String`	`getTriggerClass()`
`String`	`getTriggerDescriptor()`
`String`	`getTriggerMethod()`
`TypeGroup`	`getTypeGroup()`
`Object`	`invokeAccessibleMethod(Object target, Object[] args, int methodIndex)`
`boolean`	`isChecked()` has this rule been typechecked and/or compiled
`boolean`	`isCheckedOk()` has this rule been typechecked and compiled without error.
`boolean`	`isCheckFailed()` has this rule failed to typecheck or compile
`boolean`	`isInterface()`
`boolean`	`isOverride()`
`static boolean`	`isTriggeringEnabled()` check if triggering of rules is enabled inside the current thread
`String`	`lookupKey()` return the key under which this rule has been indexed in the rule key map
`void`	`purge()` delete any reference to the rule from the rule map
`void`	`setAccessibleField(Object owner, Object value, int fieldIndex)`
`void`	`setAction(String actionSpec)`
`void`	`setCondition(String conditionSpec)`
`void`	`setEvent(String eventSpec)`
`void`	`setTypeInfo(String className, int access, String methodName, String desc, String[] exceptions)`
`String`	`toString()` generate a string representation of the rule
`void`	`typeCheck()` type check this rule

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

- Method Detail
  - getTypeGroup
```
public TypeGroup getTypeGroup()
```
  - getBindings
```
public Bindings getBindings()
```
  - getName
```
public String getName()
```
  - getTargetClass
```
public String getTargetClass()
```
  - getTargetMethod
```
public String getTargetMethod()
```
  - getTargetLocation
```
public Location getTargetLocation()
```
  - isOverride
```
public boolean isOverride()
```
  - isInterface
```
public boolean isInterface()
```
  - getLine
```
public int getLine()
```
    retrieve the start line for the rule
    
    Returns:
    the start line for the rule
  - getFile
```
public String getFile()
```
    retrieve the name of the file containing this rule
    
    Returns:
    the name of the file containing this rule
  - getEvent
```
public Event getEvent()
```
  - getCondition
```
public Condition getCondition()
```
  - getAction
```
public Action getAction()
```
  - getTriggerClass
```
public String getTriggerClass()
```
  - getTriggerMethod
```
public String getTriggerMethod()
```
  - getTriggerDescriptor
```
public String getTriggerDescriptor()
```
  - getReturnType
```
public Type getReturnType()
```
  - getLoader
```
public ClassLoader getLoader()
```
    get the class loader of the target class for the rule
    
    Returns:
  - create
```
public static Rule create(RuleScript ruleScript,
          ClassLoader loader,
          HelperManager helperManager)
                   throws ParseException,
                          TypeException,
                          CompileException
```
    Throws:
    
    ParseException
    
    TypeException
    
    CompileException
  - setEvent
```
public void setEvent(String eventSpec)
              throws ParseException,
                     TypeException
```
    Throws:
    
    ParseException
    
    TypeException
  - setCondition
```
public void setCondition(String conditionSpec)
                  throws ParseException,
                         TypeException
```
    Throws:
    
    ParseException
    
    TypeException
  - setAction
```
public void setAction(String actionSpec)
               throws ParseException,
                      TypeException
```
    Throws:
    
    ParseException
    
    TypeException
  - setTypeInfo
```
public void setTypeInfo(String className,
               int access,
               String methodName,
               String desc,
               String[] exceptions)
```
  - isChecked
```
public boolean isChecked()
```
    has this rule been typechecked and/or compiled
    
    Returns:
    true if this rule has been typechecked and/or compiled otherwise false
  - isCheckFailed
```
public boolean isCheckFailed()
```
    has this rule failed to typecheck or compile
    
    Returns:
    true if this rule has failed to typecheck or compile otherwise false
  - isCheckedOk
```
public boolean isCheckedOk()
```
    has this rule been typechecked and compiled without error.
    
    Returns:
    true if this rule has been typechecked and compiled without error otherwise false
  - disableTriggersInternal
```
public static boolean disableTriggersInternal()
```
    disable triggering of rules inside the current thread. this is the version called internally after returning from a method call in a rule binding, condition or action.
    
    Returns:
    true if triggering was previously enabled and false if it was already disabled
  - enableTriggersInternal
```
public static boolean enableTriggersInternal()
```
    enable triggering of rules inside the current thread n.b. this is called internally by the rule engine before it executes a method call in a rule binding, condition or action. it will not enable triggers if they have been switched off by an earlier call to userDisableTriggers.
    
    Returns:
    true if triggering was previously enabled and false if it was already disabled
  - disableTriggers
```
public static boolean disableTriggers()
```
    disable triggering of rules inside the current thread. this is the version which should be called from a Helper class to ensure that subsequent method invocatiosn during execution of the current rule bindings, condition or action do not recursively trigger rules. It ensures that subsequent calls to enableTriggers have no effect. The effect lasts until the end of processing for the current rule when resetTriggers is called.
    
    Returns:
    true if triggering was previously enabled and false if it was already disabled
  - enableTriggers
```
public static boolean enableTriggers()
```
    enable triggering of rules inside the current thread. this is called internally by the rule engine after rule execution has completed. it will re-enable triggers even if they have been switched off by an earlier call to userDisableTriggers. It is also called by the default helper to reverse the effect of calling userDisableTriggers.
    
    Returns:
    true if triggering was previously enabled and false if it was already disabled
  - isTriggeringEnabled
```
public static boolean isTriggeringEnabled()
```
    check if triggering of rules is enabled inside the current thread
    
    Returns:
    true if triggering is enabled and false if it is disabled
  - typeCheck
```
public void typeCheck()
               throws TypeException
```
    type check this rule
    
    Throws:
    
    TypeException - if the ruele contains type errors
  - compile
```
public void compile()
             throws CompileException
```
    install helper class used to execute this rule. this may involve generating a compiled helper class for the rule and, if compilation to bytecode is enabled, generating bytecode for a method of this class used to execute the rule binding, condition and action expressions. If the rule employ sthe default helper without enabling compilation to bytecode then no class need be generated. the installed helper class will be the predefined class InterpretedHelper.
    
    Throws:
    
    CompileException - if the rule cannot be compiled
  - execute
```
public static void execute(String key,
           Object recipient,
           Object[] args)
                    throws ExecuteException
```
    forward an execute request a rule identified by its unique key
    
    Parameters:
    key - a string key identifying the rule instance to be fired
    recipient - the recipient of the method from which execution of the rule was triggered or null if it was a static method
    args - the arguments of the method from which execution of the rule was triggered
    
    Throws:
    
    ExecuteException
  - getKey
```
public String getKey()
```
    called when a trigger is compiled for the rule to provide a String key which can be used at execution time to obtain a handle on the rule instance
    
    Returns:
    a key which can be used later to obtain a reference to the rule
  - lookupKey
```
public String lookupKey()
```
    return the key under which this rule has been indexed in the rule key map
    
    Returns:
  - purge
```
public void purge()
```
    delete any reference to the rule from the rule map
  - toString
```
public String toString()
```
    generate a string representation of the rule
    
    Overrides:
    
    toString in class Object
    
    Returns:
    a string representation of the rule
  - getHelperClass
```
public Class getHelperClass()
```
    a getter allowing the helper class for the rule to be identified
    
    Returns:
  - addAccessibleField
```
public int addAccessibleField(Field field)
```
  - addAccessibleMethod
```
public int addAccessibleMethod(Method method)
```
  - getAccessibleField
```
public Object getAccessibleField(Object owner,
                        int fieldIndex)
                          throws ExecuteException
```
    Throws:
    
    ExecuteException
  - setAccessibleField
```
public void setAccessibleField(Object owner,
                      Object value,
                      int fieldIndex)
                        throws ExecuteException
```
    Throws:
    
    ExecuteException
  - invokeAccessibleMethod
```
public Object invokeAccessibleMethod(Object target,
                            Object[] args,
                            int methodIndex)
```

Class Rule

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getTypeGroup

getBindings

getName

getTargetClass

getTargetMethod

getTargetLocation

isOverride

isInterface

getLine

getFile

getEvent

getCondition

getAction

getTriggerClass

getTriggerMethod

getTriggerDescriptor

getReturnType

getLoader

create

setEvent

setCondition

setAction

setTypeInfo

isChecked

isCheckFailed

isCheckedOk

disableTriggersInternal

enableTriggersInternal

disableTriggers

enableTriggers

isTriggeringEnabled

typeCheck

compile

execute

getKey

lookupKey

purge

toString

getHelperClass

addAccessibleField

addAccessibleMethod

getAccessibleField

setAccessibleField

invokeAccessibleMethod