RegExpValidator (PerfCake API Documentation (version 7.5))

java.lang.Object
- org.perfcake.validation.RegExpValidator

All Implemented Interfaces:

MessageValidator
```
public class RegExpValidator
extends Object
implements MessageValidator
```
Checks the message payload for the given regular expression.

It is possible to set the Pattern.compile(String, int) compile flags using the particular properties.

All flags but Pattern.UNIX_LINES are supported. That is because StringUtil.trimLines(String) is used to pre-process the message payload that changes all line breakers to \n.

Author:

Lucie Fabriková, Martin Večeřa, Pavel Macík

See Also:

Pattern.compile(String, int)

Constructor Summary

Constructors
Constructor and Description

RegExpValidator()

Constructors
Constructor and Description
`RegExpValidator()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getPattern()` Gets the regular expression pattern.
`boolean`	`isCanonEq()` Gets the value of `Pattern.CANON_EQ` flag used to compile the regular expression pattern.
`boolean`	`isCaseInsensitive()` Gets the value of `Pattern.CASE_INSENSITIVE` flag used to compile the regular expression pattern.
`boolean`	`isComments()` Gets the value of `Pattern.COMMENTS` flag used to compile the regular expression pattern.
`boolean`	`isDotall()` Gets the value of `Pattern.DOTALL` flag used to compile the regular expression pattern.
`boolean`	`isLiteral()` Gets the value of `Pattern.LITERAL` flag used to compile the regular expression pattern.
`boolean`	`isMultiline()` Gets the value of `Pattern.MULTILINE` flag used to compile the regular expression pattern.
`boolean`	`isUnicodeCase()` Gets the value of `Pattern.UNICODE_CASE` flag used to compile the regular expression pattern.
`boolean`	`isUnicodeCharacterClass()` Gets the value of `Pattern.UNICODE_CHARACTER_CLASS` flag used to compile the regular expression pattern.
`boolean`	`isValid(Message originalMessage, Message response, Properties messageAttributes)` Makes sure the provided message is valid.
`RegExpValidator`	`setCanonEq(boolean canonEq)` Sets the value of `Pattern.CANON_EQ` flag used to compile the regular expression pattern.
`RegExpValidator`	`setCaseInsensitive(boolean caseInsensitive)` Sets the value of `Pattern.CASE_INSENSITIVE` flag used to compile the regular expression pattern.
`RegExpValidator`	`setComments(boolean comments)` Sets the value of `Pattern.COMMENTS` flag used to compile the regular expression pattern.
`RegExpValidator`	`setDotall(boolean dotall)` Sets the value of `Pattern.DOTALL` flag used to compile the regular expression pattern.
`RegExpValidator`	`setLiteral(boolean literal)` Sets the value of `Pattern.LITERAL` flag used to compile the regular expression pattern.
`RegExpValidator`	`setMultiline(boolean multiline)` sets the value of `Pattern.MULTILINE` flag used to compile the regular expression pattern.
`RegExpValidator`	`setPattern(String pattern)` Sets the regular expression pattern.
`void`	`setPatternAsElement(Element pattern)` Sets the regular expression pattern taken from `Element`'s text content.
`RegExpValidator`	`setUnicodeCase(boolean unicodeCase)` Sets the value of `Pattern.UNICODE_CASE` flag used to compile the regular expression pattern.
`RegExpValidator`	`setUnicodeCharacterClass(boolean unicodeCharacterClass)` Sets the value of `Pattern.UNICODE_CHARACTER_CLASS` flag used to compile the regular expression pattern.

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

- Constructor Detail
  - RegExpValidator
```
public RegExpValidator()
```
- Method Detail
  - isValid
```
public boolean isValid(Message originalMessage,
                       Message response,
                       Properties messageAttributes)
```
    Description copied from interface: MessageValidator
    
    Makes sure the provided message is valid.
    
    Specified by:
    
    isValid in interface MessageValidator
    
    Parameters:
    
    originalMessage - The message that has been sent.
    
    response - A response for the original message.
    
    messageAttributes - A snapshot of sequences' values and possible other attributes used for sending a message. These attributes can be used by a validator to replace placeholders.
    
    Returns:
    
    true if the message passes all validations.
  - getPattern
```
public String getPattern()
```
    Gets the regular expression pattern.
    
    Returns:
    
    The regular expression pattern.
  - setPattern
```
public RegExpValidator setPattern(String pattern)
```
    Sets the regular expression pattern.
    
    Parameters:
    
    pattern - The regular expression pattern.
    
    Returns:
    
    Instance of this to support fluent API.
  - setPatternAsElement
```
public void setPatternAsElement(Element pattern)
```
    Sets the regular expression pattern taken from Element's text content.
    
    Parameters:
    
    pattern - The DOM element from whose content the regular expression pattern is taken.
  - isComments
```
public boolean isComments()
```
    Gets the value of Pattern.COMMENTS flag used to compile the regular expression pattern.
    
    Returns:
    
    The value of Pattern.COMMENTS flag.
    
    See Also:
    
    Pattern.compile(String, int)
  - setComments
```
public RegExpValidator setComments(boolean comments)
```
    Sets the value of Pattern.COMMENTS flag used to compile the regular expression pattern.
    
    Parameters:
    
    comments - The value of Pattern.COMMENTS flag.
    
    Returns:
    
    Instance of this to support fluent API.
    
    See Also:
    
    Pattern.compile(String, int)
  - isCaseInsensitive
```
public boolean isCaseInsensitive()
```
    Gets the value of Pattern.CASE_INSENSITIVE flag used to compile the regular expression pattern.
    
    Returns:
    
    The value of Pattern.CASE_INSENSITIVE flag.
    
    See Also:
    
    Pattern.compile(String, int)
  - setCaseInsensitive
```
public RegExpValidator setCaseInsensitive(boolean caseInsensitive)
```
    Sets the value of Pattern.CASE_INSENSITIVE flag used to compile the regular expression pattern.
    
    Parameters:
    
    caseInsensitive - The value of Pattern.CASE_INSENSITIVE flag.
    
    Returns:
    
    Instance of this to support fluent API.
    
    See Also:
    
    Pattern.compile(String, int)
  - isMultiline
```
public boolean isMultiline()
```
    Gets the value of Pattern.MULTILINE flag used to compile the regular expression pattern.
    
    Returns:
    
    The value of Pattern.MULTILINE flag.
    
    See Also:
    
    Pattern.compile(String, int)
  - setMultiline
```
public RegExpValidator setMultiline(boolean multiline)
```
    sets the value of Pattern.MULTILINE flag used to compile the regular expression pattern.
    
    Parameters:
    
    multiline - The value of Pattern.MULTILINE flag.
    
    Returns:
    
    Instance of this to support fluent API.
    
    See Also:
    
    Pattern.compile(String, int)
  - isDotall
```
public boolean isDotall()
```
    Gets the value of Pattern.DOTALL flag used to compile the regular expression pattern.
    
    Returns:
    
    The value of Pattern.DOTALL flag.
    
    See Also:
    
    Pattern.compile(String, int)
  - setDotall
```
public RegExpValidator setDotall(boolean dotall)
```
    Sets the value of Pattern.DOTALL flag used to compile the regular expression pattern.
    
    Parameters:
    
    dotall - The value of Pattern.DOTALL flag.
    
    Returns:
    
    Instance of this to support fluent API.
    
    See Also:
    
    Pattern.compile(String, int)
  - isUnicodeCase
```
public boolean isUnicodeCase()
```
    Gets the value of Pattern.UNICODE_CASE flag used to compile the regular expression pattern.
    
    Returns:
    
    The value of Pattern.UNICODE_CASE flag.
    
    See Also:
    
    Pattern.compile(String, int)
  - setUnicodeCase
```
public RegExpValidator setUnicodeCase(boolean unicodeCase)
```
    Sets the value of Pattern.UNICODE_CASE flag used to compile the regular expression pattern.
    
    Parameters:
    
    unicodeCase - The value of Pattern.UNICODE_CASE flag.
    
    Returns:
    
    Instance of this to support fluent API.
    
    See Also:
    
    Pattern.compile(String, int)
  - isCanonEq
```
public boolean isCanonEq()
```
    Gets the value of Pattern.CANON_EQ flag used to compile the regular expression pattern.
    
    Returns:
    
    The value of Pattern.CANON_EQ flag.
    
    See Also:
    
    Pattern.compile(String, int)
  - setCanonEq
```
public RegExpValidator setCanonEq(boolean canonEq)
```
    Sets the value of Pattern.CANON_EQ flag used to compile the regular expression pattern.
    
    Parameters:
    
    canonEq - The value of Pattern.CANON_EQ flag.
    
    Returns:
    
    Instance of this to support fluent API.
    
    See Also:
    
    Pattern.compile(String, int)
  - isLiteral
```
public boolean isLiteral()
```
    Gets the value of Pattern.LITERAL flag used to compile the regular expression pattern.
    
    Returns:
    
    The value of Pattern.LITERAL flag.
    
    See Also:
    
    Pattern.compile(String, int)
  - setLiteral
```
public RegExpValidator setLiteral(boolean literal)
```
    Sets the value of Pattern.LITERAL flag used to compile the regular expression pattern.
    
    Parameters:
    
    literal - The value of Pattern.LITERAL flag.
    
    Returns:
    
    Instance of this to support fluent API.
    
    See Also:
    
    Pattern.compile(String, int)
  - isUnicodeCharacterClass
```
public boolean isUnicodeCharacterClass()
```
    Gets the value of Pattern.UNICODE_CHARACTER_CLASS flag used to compile the regular expression pattern.
    
    Returns:
    
    The value of Pattern.UNICODE_CHARACTER_CLASS flag.
    
    See Also:
    
    Pattern.compile(String, int)
  - setUnicodeCharacterClass
```
public RegExpValidator setUnicodeCharacterClass(boolean unicodeCharacterClass)
```
    Sets the value of Pattern.UNICODE_CHARACTER_CLASS flag used to compile the regular expression pattern.
    
    Parameters:
    
    unicodeCharacterClass - The value of Pattern.UNICODE_CHARACTER_CLASS flag.
    
    Returns:
    
    Instance of this to support fluent API.
    
    See Also:
    
    Pattern.compile(String, int)

Class RegExpValidator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RegExpValidator

Method Detail

isValid

getPattern

setPattern

setPatternAsElement

isComments

setComments

isCaseInsensitive

setCaseInsensitive

isMultiline

setMultiline

isDotall

setDotall

isUnicodeCase

setUnicodeCase

isCanonEq

setCanonEq

isLiteral

setLiteral

isUnicodeCharacterClass

setUnicodeCharacterClass