io.jmix.ui.component.validation

Class DecimalMinValidator<T>

java.lang.Object

io.jmix.ui.component.validation.AbstractValidator<T>

io.jmix.ui.component.validation.DecimalMinValidator<T>

Type Parameters:

T - BigDecimal, BigInteger, Long, Integer and String that represents BigDecimal value with current locale

All Implemented Interfaces:

Validator<T>, java.util.function.Consumer<T>

@Component(value="ui_DecimalMinValidator")
 @Scope(value="prototype")
public class DecimalMinValidator<T>
extends AbstractValidator<T>

DecimalMin validator checks that value must be greater than or equal to the specified minimum.

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

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

     @Bean("ui_DecimalMinValidator")
     @Scope(BeanDefinition.SCOPE_PROTOTYPE)
     @Primary
     protected DecimalMinValidator decimalMinValidator(BigDecimal min) {
          return new CustomDecimalMinValidator(min);
     }
 

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	inclusive
protected java.math.BigDecimal	min

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

currentAuthentication, datatypeRegistry, message, messages, substitutor

Constructor Summary

Constructors

Constructor and Description
DecimalMinValidator(java.math.BigDecimal min) Constructor with default error message.
DecimalMinValidator(java.math.BigDecimal min, java.lang.String message) Constructor with custom error message.

Method Summary

Modifier and Type	Method and Description
void	accept(T value) Checks a value.
protected void	fireValidationException(T value)
protected java.lang.String	getDefaultMessage()
java.math.BigDecimal	getMin()
boolean	isInclusive()
void	setCurrentAuthentication(io.jmix.core.security.CurrentAuthentication currentAuthentication)
protected void	setDatatypeRegistry(io.jmix.core.metamodel.datatype.DatatypeRegistry datatypeRegistry)
void	setInclusive(boolean inclusive) Set to true if the value must be greater than or equal to the specified minimum.
protected void	setMessages(io.jmix.core.Messages messages)
void	setMin(java.math.BigDecimal min) Sets min value.
void	setMin(java.math.BigDecimal min, boolean inclusive) Sets min value and inclusive option.
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

min

protected java.math.BigDecimal min

inclusive

protected boolean inclusive

Constructor Detail

DecimalMinValidator

public DecimalMinValidator(java.math.BigDecimal min)

Constructor with default error message.

Parameters:

min - min value

DecimalMinValidator

public DecimalMinValidator(java.math.BigDecimal min,
                           java.lang.String message)

Constructor with custom error message. This message can contain '${value}', and '${min}' keys for formatted output.

Example: "Value '${value}' should be greater than or equal to '${min}'".

Parameters:

min - min value

message - error message

Method Detail

setMessages

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

setDatatypeRegistry

@Autowired
protected void setDatatypeRegistry(io.jmix.core.metamodel.datatype.DatatypeRegistry datatypeRegistry)

setCurrentAuthentication

@Autowired
public void setCurrentAuthentication(io.jmix.core.security.CurrentAuthentication currentAuthentication)

setStringSubstitutor

@Autowired
public void setStringSubstitutor(StringSubstitutor substitutor)

setMin

@StudioProperty(name="value",
                required=true)
public void setMin(java.math.BigDecimal min)

Sets min value.

Parameters:

min - min value

getMin

public java.math.BigDecimal getMin()

Returns:

min value

setMin

public void setMin(java.math.BigDecimal min,
                   boolean inclusive)

Sets min value and inclusive option.

Parameters:

min - min value

inclusive - inclusive option

setInclusive

@StudioProperty
public void setInclusive(boolean inclusive)

Set to true if the value must be greater than or equal to the specified minimum. Default value is true.

Parameters:

inclusive - inclusive option

isInclusive

public boolean isInclusive()

Returns:

true if the value must be greater than or equal to the specified minimum

accept

public void accept(T value)
            throws ValidationException

Description copied from interface: Validator

Checks a value.

Parameters:

value - a value

Throws:

ValidationException

getDefaultMessage

protected java.lang.String getDefaultMessage()

fireValidationException

protected void fireValidationException(T value)