MatchCondition (Interlok Transform/STaX)

java.lang.Object
- com.adaptris.stax.services.MatchCondition

All Implemented Interfaces:

ComponentLifecycle, InputCondition
```
@ComponentProfile(summary="InputCondition implementation that matches against a specific regular expression",
                  since="3.8.4")
public class MatchCondition
extends java.lang.Object
implements InputCondition
```
InputCondition implementation that matches against a regular expression.

In the adapter configuration file this class is aliased as stax-plugin-match-rule which is the preferred alternative to the fully qualified classname when building your configuration.

Constructor Summary

Constructors
Constructor Description

MatchCondition()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getMatches()`
`java.lang.String`	`getWhen()`
`void`	`init()`
`boolean`	`matches(AdaptrisMessage msg)`	Whether or not this message should have the plugin applied.
`void`	`setMatches(java.lang.String s)`	Set the regular expression to match `getWhen()` against.
`void`	`setWhen(java.lang.String s)`	Specify the value to check against when determining whether to apply the transform plugin.
`MatchCondition`	`withMatches(java.lang.String regexp)`
`MatchCondition`	`withWhen(java.lang.String v)`

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

Methods inherited from interface com.adaptris.core.ComponentLifecycle
close, start, stop

- Constructor Detail
  - MatchCondition
```
public MatchCondition()
```
- Method Detail
  - init
```
public void init()
          throws CoreException
```
    Specified by:
    
    init in interface ComponentLifecycle
    
    Throws:
    
    CoreException
  - matches
```
public boolean matches(AdaptrisMessage msg)
```
    Description copied from interface: InputCondition
    
    Whether or not this message should have the plugin applied.
    
    Specified by:
    
    matches in interface InputCondition
    
    Parameters:
    
    msg - the message
    
    Returns:
    
    true or false.
  - getWhen
```
public java.lang.String getWhen()
```
  - setWhen
```
public void setWhen(java.lang.String s)
```
    Specify the value to check against when determining whether to apply the transform plugin.
    
    Parameters:
    
    s - the value, which supports the %message{} syntax to resolve metadata.
  - withWhen
```
public MatchCondition withWhen(java.lang.String v)
```
    See Also:
    
    setWhen(String)
  - getMatches
```
public java.lang.String getMatches()
```
  - setMatches
```
public void setMatches(java.lang.String s)
```
    Set the regular expression to match getWhen() against.
    
    Parameters:
    
    s - a string that conforms to java.util.Pattern syntax.
  - withMatches
```
public MatchCondition withMatches(java.lang.String regexp)
```
    See Also:
    
    setMatches(String)