io.jmix.ui.component.validation

Class RegexpValidator

java.lang.Object

io.jmix.ui.component.validation.AbstractValidator<java.lang.String>

io.jmix.ui.component.validation.RegexpValidator

All Implemented Interfaces:

Validator<java.lang.String>, java.util.function.Consumer<java.lang.String>

@Scope(value="prototype")
 @Component(value="ui_RegexpValidator")
public class RegexpValidator
extends AbstractValidator<java.lang.String>

Regexp validator checks that String value is matched with specified regular expression.

The regular expression follows the Java regular expression conventions.

For error message it uses template string and it is possible to use '${value}' key for formatted output.

In order to provide your own implementation globally, create a subclass and register it in configuration class, for example:

     @Bean("ui_RegexpValidator")
     @Scope(BeanDefinition.SCOPE_PROTOTYPE)
     @Primary
     protected RegexpValidator regexpValidator(String regexp) {
          return new CustomRegexpValidator(regexp);
     }
 

See Also:

Pattern

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.regex.Pattern	pattern

Fields inherited from class io.jmix.ui.component.validation.AbstractValidator

currentAuthentication, datatypeRegistry, message, messages, substitutor

Constructor Summary

Constructors

Constructor and Description
RegexpValidator(java.lang.String regexp)
RegexpValidator(java.lang.String regexp, java.lang.String message) Constructor for regexp value and custom error message.

Method Summary

Modifier and Type	Method and Description
void	accept(java.lang.String value) Checks a value.
java.lang.String	getRegexp()
protected void	setMessages(io.jmix.core.Messages messages)
void	setRegexp(java.lang.String regexp) Sets regexp pattern value.
void	setStringSubstitutor(StringSubstitutor substitutor)

Methods inherited from class io.jmix.ui.component.validation.AbstractValidator

formatValue, getMessage, getTemplateErrorMessage, setMessage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.function.Consumer

andThen

Field Detail

pattern

protected java.util.regex.Pattern pattern

Constructor Detail

RegexpValidator

public RegexpValidator(java.lang.String regexp)

RegexpValidator

public RegexpValidator(java.lang.String regexp,
                       java.lang.String message)

Constructor for regexp value and custom error message. This message can contain '${value}' key for formatted output. Example: "Invalid value '${value}'".

Parameters:

regexp - regular expression

message - error message

Method Detail

setMessages

@Autowired
protected void setMessages(io.jmix.core.Messages messages)

setStringSubstitutor

@Autowired
public void setStringSubstitutor(StringSubstitutor substitutor)

setRegexp

@StudioProperty(required=true)
public void setRegexp(java.lang.String regexp)

Sets regexp pattern value.

Parameters:

regexp - a regexp pattern value

getRegexp

public java.lang.String getRegexp()

Returns:

a regexp pattern value

accept

public void accept(java.lang.String value)
            throws ValidationException

Description copied from interface: Validator

Checks a value.

Parameters:

value - a value

Throws:

ValidationException