io.jmix.ui.component.validation

Class DecimalMaxValidator<T>

java.lang.Object

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

io.jmix.ui.component.validation.DecimalMaxValidator<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_DecimalMaxValidator")
 @Scope(value="prototype")
public class DecimalMaxValidator<T>
extends AbstractValidator<T>

DecimalMax validator checks that value must be less than or equal to the specified maximum.

For error message it uses template string and it is possible to use '${value}' and '${max}' 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_DecimalMaxValidator")
     @Scope(BeanDefinition.SCOPE_PROTOTYPE)
     @Primary
     protected DecimalMaxValidator decimalMaxValidator(BigDecimal max) {
          return new CustomDecimalMaxValidator(max);
     }
 

Field Summary

Fields

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

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

currentAuthentication, datatypeRegistry, message, messages, substitutor

Constructor Summary

Constructors

Constructor and Description
DecimalMaxValidator(java.math.BigDecimal max) Constructor with default error message.
DecimalMaxValidator(java.math.BigDecimal max, 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	getMax()
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 less than or equal to the specified maximum.
void	setMax(java.math.BigDecimal max) Sets max value.
void	setMax(java.math.BigDecimal max, boolean inclusive) Sets max value and inclusive option.
protected void	setMessages(io.jmix.core.Messages messages)
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

max

protected java.math.BigDecimal max

inclusive

protected boolean inclusive

Constructor Detail

DecimalMaxValidator

public DecimalMaxValidator(java.math.BigDecimal max)

Constructor with default error message.

Parameters:

max - max value

DecimalMaxValidator

public DecimalMaxValidator(java.math.BigDecimal max,
                           java.lang.String message)

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

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

Parameters:

max - max 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)

setMax

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

Sets max value.

Parameters:

max - max value

getMax

public java.math.BigDecimal getMax()

Returns:

max value

setMax

public void setMax(java.math.BigDecimal max,
                   boolean inclusive)

Sets max value and inclusive option.

Parameters:

max - max value

inclusive - inclusive option

setInclusive

@StudioProperty
public void setInclusive(boolean inclusive)

Set to true if the value must be less than or equal to the specified maximum. Default value is true.

Parameters:

inclusive - inclusive option

isInclusive

public boolean isInclusive()

Returns:

true if the value must be less than or equal to the specified maximum

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)