ValidationMessages (Validations Module 1.4.3 API)

java.lang.Object
- org.mule.runtime.api.i18n.I18nMessageFactory
- - org.mule.extension.validation.internal.ValidationMessages

```
public final class ValidationMessages
extends org.mule.runtime.api.i18n.I18nMessageFactory
```
A I18nMessageFactory 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:

1.0

Field Summary
- Fields inherited from class org.mule.runtime.api.i18n.I18nMessageFactory
  DEFAULT_RELOAD_CONTROL, 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
`org.mule.runtime.api.i18n.I18nMessage`	`collectionIsEmpty()` Generates a `I18nMessage` for a value that was expected to be not empty but was
`org.mule.runtime.api.i18n.I18nMessage`	`collectionIsNotEmpty()` Generates a `I18nMessage` for a `Collection` which was expected to be empty but wasn't
`org.mule.runtime.api.i18n.I18nMessage`	`elapsedTime(LocalDateTime createdTime, Duration expiresIn, LocalDateTime currentTime)` Generates a `I18nMessage` for an elapsed time $`createdTime` that exceeded duration $`expiresIn` after $`currentTime`.
`org.mule.runtime.api.i18n.I18nMessage`	`failedBooleanValidation(boolean value, boolean expected)` Generates a `I18nMessage` for a boolean validation that failed
`protected ResourceBundle`	`getBundle(String bundlePath)`
`org.mule.runtime.api.i18n.I18nMessage`	`greaterThan(Object value, Object boundary)` Returns a message for a `value` that was expected to be greater than `boundary` but isn't
`org.mule.runtime.api.i18n.I18nMessage`	`greaterThanMaxSize(Object value, int maxSize, int actualSize)` Generates a `I18nMessage` for a value that was expected to have a maximum size but didn't
`org.mule.runtime.api.i18n.I18nMessage`	`invalidEmail(String email)` Generates a `I18nMessage` for an email validation that failed
`org.mule.runtime.api.i18n.I18nMessage`	`invalidIp(String ip)` Generates a `I18nMessage` for an ip address validation that failed
`org.mule.runtime.api.i18n.I18nMessage`	`invalidNumberType(Object value, String numberType)` Generates a `I18nMessage` for a number type validation that failed
`org.mule.runtime.api.i18n.I18nMessage`	`invalidTime(String time, String locale, String pattern)` Generates a `I18nMessage` for a `time` expressed as a `String` but couldn't be parsed using the given `locale` and `pattern`
`org.mule.runtime.api.i18n.I18nMessage`	`invalidUrl(String url)` Generates a `I18nMessage` for a `url` that is not valid
`org.mule.runtime.api.i18n.I18nMessage`	`lowerThan(Object value, Object boundary)` Returns a message for a `value` that was expected to be lower than `boundary` but isn't
`org.mule.runtime.api.i18n.I18nMessage`	`lowerThanMinSize(Object value, int minSize, int actualSize)` Generates a `I18nMessage` for a value that was expected to have a minimum size but didn't
`org.mule.runtime.api.i18n.I18nMessage`	`mapIsEmpty()` Generates a `I18nMessage` for a map that was expected to be not empty but was
`org.mule.runtime.api.i18n.I18nMessage`	`mapIsNotEmpty()` Generates a `I18nMessage` for a `Map` which was expected to be empty but wasn't
`org.mule.runtime.api.i18n.I18nMessage`	`notElapsedTime(LocalDateTime createdTime, Duration expiresIn, LocalDateTime currentTime)` Generates a `I18nMessage` for an elapsed time $`createdTime` that did not exceeded duration $`expiresIn` after $`currentTime`.
`org.mule.runtime.api.i18n.I18nMessage`	`regexDoesNotMatch(String value, String regex)` Generates a `I18nMessage` for a `value` which doesn't match a given `regex`
`org.mule.runtime.api.i18n.I18nMessage`	`rejectedIp(String ip)` Generates a `I18nMessage` for an ip address filter validation that failed
`org.mule.runtime.api.i18n.I18nMessage`	`stringIsBlank()` Generates a `I18nMessage` for a string that was expected to be not blank but wasn't
`org.mule.runtime.api.i18n.I18nMessage`	`stringIsNotBlank()` Generates a `I18nMessage` for a String which was expected to be blank but wasn't
`org.mule.runtime.api.i18n.I18nMessage`	`valueIsNull()` Generates a `I18nMessage` for a value that is `null` what it wasn't expected to be
`org.mule.runtime.api.i18n.I18nMessage`	`wasExpectingNull()` Generates a `I18nMessage` for a value that was expected to be `null` but wasn't

Methods inherited from class org.mule.runtime.api.i18n.I18nMessageFactory
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 org.mule.runtime.api.i18n.I18nMessageFactory
  - failedBooleanValidation
```
public org.mule.runtime.api.i18n.I18nMessage failedBooleanValidation(boolean value,
                                                                     boolean expected)
```
    Generates a I18nMessage for a boolean validation that failed
    
    Parameters:
    
    value - the value that was obtained
    
    expected - the value that was expected
    
    Returns:
    
    a I18nMessage
  - invalidNumberType
```
public org.mule.runtime.api.i18n.I18nMessage invalidNumberType(Object value,
                                                               String numberType)
```
    Generates a I18nMessage 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 I18nMessage
  - lowerThan
```
public org.mule.runtime.api.i18n.I18nMessage 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 I18nMessage
  - greaterThan
```
public org.mule.runtime.api.i18n.I18nMessage 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 I18nMessage
  - invalidEmail
```
public org.mule.runtime.api.i18n.I18nMessage invalidEmail(String email)
```
    Generates a I18nMessage for an email validation that failed
    
    Parameters:
    
    email - the validated email address
    
    Returns:
    
    a I18nMessage
  - invalidIp
```
public org.mule.runtime.api.i18n.I18nMessage invalidIp(String ip)
```
    Generates a I18nMessage for an ip address validation that failed
    
    Parameters:
    
    ip - the validated ip address
    
    Returns:
    
    a I18nMessage
  - rejectedIp
```
public org.mule.runtime.api.i18n.I18nMessage rejectedIp(String ip)
```
    Generates a I18nMessage for an ip address filter validation that failed
    
    Parameters:
    
    ip - the rejected ip address
    
    Returns:
    
    a I18nMessage
  - lowerThanMinSize
```
public org.mule.runtime.api.i18n.I18nMessage lowerThanMinSize(Object value,
                                                              int minSize,
                                                              int actualSize)
```
    Generates a I18nMessage 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 I18nMessage
  - greaterThanMaxSize
```
public org.mule.runtime.api.i18n.I18nMessage greaterThanMaxSize(Object value,
                                                                int maxSize,
                                                                int actualSize)
```
    Generates a I18nMessage 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 I18nMessage
  - valueIsNull
```
public org.mule.runtime.api.i18n.I18nMessage valueIsNull()
```
    Generates a I18nMessage for a value that is null what it wasn't expected to be
    
    Returns:
    
    a I18nMessage
  - collectionIsEmpty
```
public org.mule.runtime.api.i18n.I18nMessage collectionIsEmpty()
```
    Generates a I18nMessage for a value that was expected to be not empty but was
    
    Returns:
    
    a I18nMessage
  - stringIsBlank
```
public org.mule.runtime.api.i18n.I18nMessage stringIsBlank()
```
    Generates a I18nMessage for a string that was expected to be not blank but wasn't
    
    Returns:
    
    a I18nMessage
  - mapIsEmpty
```
public org.mule.runtime.api.i18n.I18nMessage mapIsEmpty()
```
    Generates a I18nMessage for a map that was expected to be not empty but was
    
    Returns:
    
    a I18nMessage
  - wasExpectingNull
```
public org.mule.runtime.api.i18n.I18nMessage wasExpectingNull()
```
    Generates a I18nMessage for a value that was expected to be null but wasn't
    
    Returns:
    
    a I18nMessage
  - invalidTime
```
public org.mule.runtime.api.i18n.I18nMessage invalidTime(String time,
                                                         String locale,
                                                         String pattern)
```
    Generates a I18nMessage 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 I18nMessage
  - elapsedTime
```
public org.mule.runtime.api.i18n.I18nMessage elapsedTime(LocalDateTime createdTime,
                                                         Duration expiresIn,
                                                         LocalDateTime currentTime)
```
    Generates a I18nMessage for an elapsed time $createdTime that exceeded duration $expiresIn after $currentTime.
    
    Parameters:
    
    createdTime - the original time to verify
    
    expiresIn - maximum allowed difference between the created and actual time
    
    currentTime - the time used to validate against
    
    Returns:
    
    a I18nMessage
  - notElapsedTime
```
public org.mule.runtime.api.i18n.I18nMessage notElapsedTime(LocalDateTime createdTime,
                                                            Duration expiresIn,
                                                            LocalDateTime currentTime)
```
    Generates a I18nMessage for an elapsed time $createdTime that did not exceeded duration $expiresIn after $currentTime.
    
    Parameters:
    
    createdTime - the original time to verify
    
    expiresIn - minimum allowed difference between the created and actual time
    
    currentTime - the time used to validate against
    
    Returns:
    
    a I18nMessage
  - invalidUrl
```
public org.mule.runtime.api.i18n.I18nMessage invalidUrl(String url)
```
    Generates a I18nMessage for a url that is not valid
    
    Parameters:
    
    url - the tested url
    
    Returns:
    
    a I18nMessage
  - regexDoesNotMatch
```
public org.mule.runtime.api.i18n.I18nMessage regexDoesNotMatch(String value,
                                                               String regex)
```
    Generates a I18nMessage 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 I18nMessage
  - stringIsNotBlank
```
public org.mule.runtime.api.i18n.I18nMessage stringIsNotBlank()
```
    Generates a I18nMessage for a String which was expected to be blank but wasn't
    
    Returns:
    
    a I18nMessage
  - collectionIsNotEmpty
```
public org.mule.runtime.api.i18n.I18nMessage collectionIsNotEmpty()
```
    Generates a I18nMessage for a Collection which was expected to be empty but wasn't
    
    Returns:
    
    a I18nMessage
  - mapIsNotEmpty
```
public org.mule.runtime.api.i18n.I18nMessage mapIsNotEmpty()
```
    Generates a I18nMessage for a Map which was expected to be empty but wasn't
    
    Returns:
    
    a I18nMessage

Class ValidationMessages

Field Summary

Fields inherited from class org.mule.runtime.api.i18n.I18nMessageFactory

Constructor Summary

Method Summary

Methods inherited from class org.mule.runtime.api.i18n.I18nMessageFactory

Methods inherited from class java.lang.Object

Constructor Detail

ValidationMessages

ValidationMessages

Method Detail

getBundle

failedBooleanValidation

invalidNumberType

lowerThan

greaterThan

invalidEmail

invalidIp

rejectedIp

lowerThanMinSize

greaterThanMaxSize

valueIsNull

collectionIsEmpty

stringIsBlank

mapIsEmpty

wasExpectingNull

invalidTime

elapsedTime

notElapsedTime

invalidUrl

regexDoesNotMatch

stringIsNotBlank

collectionIsNotEmpty

mapIsNotEmpty