ValidationMessages (Mule Validation Extension 3.9.6-SNAPSHOT API)

java.lang.Object
- org.mule.config.i18n.MessageFactory
- - org.mule.extension.validation.internal.ValidationMessages

```
public final class ValidationMessages
extends MessageFactory
```
A MessageFactory that provides the feedback messages for the Validators that are provided out of the box. By default, it uses a default bundle with the default messages in english language, but it is also possible to provide a custom bundle and Locale

Since:

3.7.0

Field Summary
- Fields inherited from class org.mule.config.i18n.MessageFactory
  DEFAULT_RELOAD_CONTROL, logger, reloadControl

Constructor Summary

Constructors
Constructor and Description
`ValidationMessages()` Creates an instance which uses the default english language bundle which ships with the module
`ValidationMessages(String bundlePath, String locale)` Creates an instance which points to the given `bundlePath` and `locale`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Message`	`arrayIsEmpty()` Generates a `Message` for an array which was expected to be not empty but was
`Message`	`arrayIsNotEmpty()` Generates a `Message` for an array which was expected to be empty but wasn't
`Message`	`collectionIsEmpty()` Generates a `Message` for a value that was expected to be not empty but was
`Message`	`collectionIsNotEmpty()` Generates a `Message` for a `Collection` which was expected to be empty but wasn't
`Message`	`failedBooleanValidation(boolean value, boolean expected)` Generates a `Message` for a boolean validation that failed
`protected ResourceBundle`	`getBundle(String bundlePath)`
`Message`	`greaterThan(Object value, Object boundary)` Returns a message for a `value` that was expected to be greater than `boundary` but isn't
`Message`	`greaterThanMaxSize(Object value, int maxSize, int actualSize)` Generates a `Message` for a value that was expected to have a maximum size but didn't
`Message`	`invalidEmail(String email)` Generates a `Message` for an email validation that failed
`Message`	`invalidIp(String ip)` Generates a `Message` for an ip address validation that failed
`Message`	`invalidNumberType(Object value, String numberType)` Generates a `Message` for a number type validation that failed
`Message`	`invalidTime(String time, String locale, String pattern)` Generates a `Message` for a `time` expressed as a `String` but couldn't be parsed using the given `locale` and `pattern`
`Message`	`invalidUrl(String url)` Generates a `Message` for a `url` that is not valid
`Message`	`lowerThan(Object value, Object boundary)` Returns a message for a `value` that was expected to be lower than `boundary` but isn't
`Message`	`lowerThanMinSize(Object value, int minSize, int actualSize)` Generates a `Message` for a value that was expected to have a minimum size but didn't
`Message`	`mapIsEmpty()` Generates a `Message` for a map that was expected to be not empty but was
`Message`	`mapIsNotEmpty()` Generates a `Message` for a `Map` which was expected to be empty but wasn't
`Message`	`regexDoesNotMatch(String value, String regex)` Generates a `Message` for a `value` which doesn't match a given `regex`
`Message`	`stringIsBlank()` Generates a `Message` for a string that was expected to be not blank but wasn't
`Message`	`stringIsNotBlank()` Generates a `Message` for a String which was expected to be blank but wasn't
`Message`	`valueIsBlankLiteral()` Generates a `Message` for a value that was expected to not be a `BlankLiteral` but was
`Message`	`valueIsNull()` Generates a `Message` for a value that is `null` what it wasn't expected to be
`Message`	`wasExpectingNull()` Generates a `Message` for a value that was expected to be `null` but wasn't

Methods inherited from class org.mule.config.i18n.MessageFactory
createMessage, createMessage, createMessage, createMessage, createMessage, createStaticMessage, createStaticMessage, getBundlePath, getClassLoader, getReloadControl, getString, getString, getString, getString

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

- Constructor Detail
  - ValidationMessages
```
public ValidationMessages()
```
    Creates an instance which uses the default english language bundle which ships with the module
  - ValidationMessages
```
public ValidationMessages(String bundlePath,
                          String locale)
```
    Creates an instance which points to the given bundlePath and locale
    
    Parameters:
    
    bundlePath - the path to a bundle
    
    locale - a locale key to be used to construct a Locale
- Method Detail
  - getBundle
```
protected ResourceBundle getBundle(String bundlePath)
```
    Overrides:
    
    getBundle in class MessageFactory
  - failedBooleanValidation
```
public Message failedBooleanValidation(boolean value,
                                       boolean expected)
```
    Generates a Message for a boolean validation that failed
    
    Parameters:
    
    value - the value that was obtained
    
    expected - the value that was expected
    
    Returns:
    
    a Message
  - invalidNumberType
```
public Message invalidNumberType(Object value,
                                 String numberType)
```
    Generates a Message for a number type validation that failed
    
    Parameters:
    
    value - the value that was tested
    
    numberType - the type that the tested value was expected to have
    
    Returns:
    
    a Message
  - lowerThan
```
public Message lowerThan(Object value,
                         Object boundary)
```
    Returns a message for a value that was expected to be lower than boundary but isn't
    
    Parameters:
    
    value - the value
    
    boundary - the boundary
    
    Returns:
    
    a Message
  - greaterThan
```
public Message greaterThan(Object value,
                           Object boundary)
```
    Returns a message for a value that was expected to be greater than boundary but isn't
    
    Parameters:
    
    value - the value
    
    boundary - the boundary
    
    Returns:
    
    a Message
  - invalidEmail
```
public Message invalidEmail(String email)
```
    Generates a Message for an email validation that failed
    
    Parameters:
    
    email - the validated email address
    
    Returns:
    
    a Message
  - invalidIp
```
public Message invalidIp(String ip)
```
    Generates a Message for an ip address validation that failed
    
    Parameters:
    
    ip - the validated ip address
    
    Returns:
    
    a Message
  - lowerThanMinSize
```
public Message lowerThanMinSize(Object value,
                                int minSize,
                                int actualSize)
```
    Generates a Message for a value that was expected to have a minimum size but didn't
    
    Parameters:
    
    value - the tested value
    
    minSize - the minimum boundary used in the validation
    
    actualSize - the actual value size
    
    Returns:
    
    a Message
  - greaterThanMaxSize
```
public Message greaterThanMaxSize(Object value,
                                  int maxSize,
                                  int actualSize)
```
    Generates a Message for a value that was expected to have a maximum size but didn't
    
    Parameters:
    
    value - the tested value
    
    maxSize - the maximum boundary used in the validation
    
    actualSize - the actual value size
    
    Returns:
    
    a Message
  - valueIsNull
```
public Message valueIsNull()
```
    Generates a Message for a value that is null what it wasn't expected to be
    
    Returns:
    
    a Message
  - collectionIsEmpty
```
public Message collectionIsEmpty()
```
    Generates a Message for a value that was expected to be not empty but was
    
    Returns:
    
    a Message
  - stringIsBlank
```
public Message stringIsBlank()
```
    Generates a Message for a string that was expected to be not blank but wasn't
    
    Returns:
    
    a Message
  - mapIsEmpty
```
public Message mapIsEmpty()
```
    Generates a Message for a map that was expected to be not empty but was
    
    Returns:
    
    a Message
  - valueIsBlankLiteral
```
public Message valueIsBlankLiteral()
```
    Generates a Message for a value that was expected to not be a BlankLiteral but was
    
    Returns:
    
    a Message
  - wasExpectingNull
```
public Message wasExpectingNull()
```
    Generates a Message for a value that was expected to be null but wasn't
    
    Returns:
    
    a Message
  - invalidTime
```
public Message invalidTime(String time,
                           String locale,
                           String pattern)
```
    Generates a Message for a time expressed as a String but couldn't be parsed using the given locale and pattern
    
    Parameters:
    
    time - the String that couldn't be parsed
    
    locale - the locale that was used when parsing
    
    pattern - the pattern that was used when parsing
    
    Returns:
    
    a Message
  - invalidUrl
```
public Message invalidUrl(String url)
```
    Generates a Message for a url that is not valid
    
    Parameters:
    
    url - the tested url
    
    Returns:
    
    a Message
  - regexDoesNotMatch
```
public Message regexDoesNotMatch(String value,
                                 String regex)
```
    Generates a Message for a value which doesn't match a given regex
    
    Parameters:
    
    value - the tested value
    
    regex - the regex that the value was tested against
    
    Returns:
    
    a Message
  - arrayIsEmpty
```
public Message arrayIsEmpty()
```
    Generates a Message for an array which was expected to be not empty but was
    
    Returns:
    
    a Message
  - stringIsNotBlank
```
public Message stringIsNotBlank()
```
    Generates a Message for a String which was expected to be blank but wasn't
    
    Returns:
    
    a Message
  - collectionIsNotEmpty
```
public Message collectionIsNotEmpty()
```
    Generates a Message for a Collection which was expected to be empty but wasn't
    
    Returns:
    
    a Message
  - mapIsNotEmpty
```
public Message mapIsNotEmpty()
```
    Generates a Message for a Map which was expected to be empty but wasn't
    
    Returns:
    
    a Message
  - arrayIsNotEmpty
```
public Message arrayIsNotEmpty()
```
    Generates a Message for an array which was expected to be empty but wasn't
    
    Returns:
    
    a Message

Class ValidationMessages

Field Summary

Fields inherited from class org.mule.config.i18n.MessageFactory

Constructor Summary

Method Summary

Methods inherited from class org.mule.config.i18n.MessageFactory

Methods inherited from class java.lang.Object

Constructor Detail

ValidationMessages

ValidationMessages

Method Detail

getBundle

failedBooleanValidation

invalidNumberType

lowerThan

greaterThan

invalidEmail

invalidIp

lowerThanMinSize

greaterThanMaxSize

valueIsNull

collectionIsEmpty

stringIsBlank

mapIsEmpty

valueIsBlankLiteral

wasExpectingNull

invalidTime

invalidUrl

regexDoesNotMatch

arrayIsEmpty

stringIsNotBlank

collectionIsNotEmpty

mapIsNotEmpty

arrayIsNotEmpty