InstrumentRule (Hawkular BTM::API 0.7.2.Final API)

java.lang.Object
- org.hawkular.btm.api.model.config.instrumentation.InstrumentRule

```
public class InstrumentRule
extends Object
```
This class represents an instrumentation rule.

Author:

gbrown

Constructor Summary

Constructors
Constructor and Description

InstrumentRule()

Constructors
Constructor and Description
`InstrumentRule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<InstrumentAction>`	`getActions()`
`List<InstrumentBind>`	`getBinds()`
`String`	`getClassName()`
`String`	`getCondition()`
`String`	`getFromVersion()`
`String`	`getHelper()`
`String`	`getInterfaceName()`
`String`	`getLocation()`
`String`	`getMethodName()`
`List<String>`	`getNotes()`
`List<String>`	`getParameterTypes()`
`String`	`getRuleName()`
`String`	`getToVersion()`
`boolean`	`isVersionValid(String version)` This method determines if the rule is valid for the supplied version.
`void`	`setActions(List<InstrumentAction> actions)`
`void`	`setBinds(List<InstrumentBind> binds)`
`void`	`setClassName(String className)`
`void`	`setCondition(String condition)`
`void`	`setFromVersion(String version)`
`void`	`setHelper(String helper)`
`void`	`setInterfaceName(String interfaceName)`
`void`	`setLocation(String location)`
`void`	`setMethodName(String methodName)`
`void`	`setNotes(List<String> notes)`
`void`	`setParameterTypes(List<String> parameterTypes)`
`void`	`setRuleName(String ruleName)`
`void`	`setToVersion(String version)`

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

- Constructor Detail
  - InstrumentRule
```
public InstrumentRule()
```
- Method Detail
  - getRuleName
```
public String getRuleName()
```
    Returns:
    
    the ruleName
  - setRuleName
```
public void setRuleName(String ruleName)
```
    Parameters:
    
    ruleName - the ruleName to set
  - getNotes
```
public List<String> getNotes()
```
    Returns:
    
    the notes
  - setNotes
```
public void setNotes(List<String> notes)
```
    Parameters:
    
    notes - the notes to set
  - getClassName
```
public String getClassName()
```
    Returns:
    
    the className
  - setClassName
```
public void setClassName(String className)
```
    Parameters:
    
    className - the className to set
  - getInterfaceName
```
public String getInterfaceName()
```
    Returns:
    
    the interfaceName
  - setInterfaceName
```
public void setInterfaceName(String interfaceName)
```
    Parameters:
    
    interfaceName - the interfaceName to set
  - getMethodName
```
public String getMethodName()
```
    Returns:
    
    the methodName
  - setMethodName
```
public void setMethodName(String methodName)
```
    Parameters:
    
    methodName - the method to set
  - getParameterTypes
```
public List<String> getParameterTypes()
```
    Returns:
    
    the parameterTypes
  - setParameterTypes
```
public void setParameterTypes(List<String> parameterTypes)
```
    Parameters:
    
    parameterTypes - the parameterTypes to set
  - getHelper
```
public String getHelper()
```
    Returns:
    
    the helper
  - setHelper
```
public void setHelper(String helper)
```
    Parameters:
    
    helper - the helper to set
  - getLocation
```
public String getLocation()
```
    Returns:
    
    the location
  - setLocation
```
public void setLocation(String location)
```
    Parameters:
    
    location - the location to set
  - getBinds
```
public List<InstrumentBind> getBinds()
```
    Returns:
    
    the binds
  - setBinds
```
public void setBinds(List<InstrumentBind> binds)
```
    Parameters:
    
    binds - the binds to set
  - getCondition
```
public String getCondition()
```
    Returns:
    
    the condition
  - setCondition
```
public void setCondition(String condition)
```
    Parameters:
    
    condition - the condition to set
  - getActions
```
public List<InstrumentAction> getActions()
```
    Returns:
    
    the actions
  - setActions
```
public void setActions(List<InstrumentAction> actions)
```
    Parameters:
    
    actions - the actions to set
  - getFromVersion
```
public String getFromVersion()
```
    Returns:
    
    the 'from' version
  - setFromVersion
```
public void setFromVersion(String version)
```
    Parameters:
    
    version - the 'from' version to set
  - getToVersion
```
public String getToVersion()
```
    Returns:
    
    the 'to' version
  - setToVersion
```
public void setToVersion(String version)
```
    Parameters:
    
    version - the 'to' version to set
  - isVersionValid
```
public boolean isVersionValid(String version)
```
    This method determines if the rule is valid for the supplied version. If the supplied version is null, then it is assumed to represent 'latest version' and therefore any rule with a 'toVersion' set will not be valid.
    
    Parameters:
    
    version - The version
    
    Returns:
    
    Whether the rule is valid for the supplied version

Class InstrumentRule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

InstrumentRule

Method Detail

getRuleName

setRuleName

getNotes

setNotes

getClassName

setClassName

getInterfaceName

setInterfaceName

getMethodName

setMethodName

getParameterTypes

setParameterTypes

getHelper

setHelper

getLocation

setLocation

getBinds

setBinds

getCondition

setCondition

getActions

setActions

getFromVersion

setFromVersion

getToVersion

setToVersion

isVersionValid