net.sf.mmm.util.validation.base.AbstractValidator Maven / Gradle / Ivy
Show all versions of mmm-util-validation Show documentation
/* Copyright (c) The m-m-m Team, Licensed under the Apache License, Version 2.0
* http://www.apache.org/licenses/LICENSE-2.0 */
package net.sf.mmm.util.validation.base;
import java.util.Objects;
import net.sf.mmm.util.nls.api.NlsAccess;
import net.sf.mmm.util.nls.api.NlsBundle;
import net.sf.mmm.util.pojo.path.api.TypedProperty;
import net.sf.mmm.util.validation.api.ValidationFailure;
import net.sf.mmm.util.validation.api.ValueValidator;
/**
* This is the abstract base class all {@link ValueValidator} implementations should extend.
*
* @param is the generic type of the value to {@link #validate(Object) validate}.
*
* @author Joerg Hohwiller (hohwille at users.sourceforge.net)
* @since 3.1.0
*/
public abstract class AbstractValidator implements ValueValidator {
/** {@link #getProperty(TypedProperty) Property} for {@link #isMandatory() mandatory flag}. */
public static final TypedProperty PROPERTY_MANDATORY = new TypedProperty<>(Boolean.class, "mandatory");
/** {@link #getProperty(TypedProperty) Property} for minimum value ({@code null} if unbounded). */
@SuppressWarnings("rawtypes")
public static final TypedProperty PROPERTY_MINIMUM = new TypedProperty<>(Comparable.class, "min");
/** {@link #getProperty(TypedProperty) Property} for maximum value ({@code null} if unbounded). */
@SuppressWarnings("rawtypes")
public static final TypedProperty PROPERTY_MAXIMUM = new TypedProperty<>(Comparable.class, "max");
/**
* The constructor.
*/
public AbstractValidator() {
super();
}
/**
* This is the default implementation to retrieve the {@link ValidationFailure#getCode() code} of this
* {@link ValueValidator}.
* ATTENTION:
* This default implementation returns the {@link Class#getSimpleName() classname} of the actual
* {@link ValueValidator} implementation. This strategy is chosen for simplicity when implementing a new validator. To
* ensure stable codes override this method and return a string constant. This shall at least be done when the name of
* the class is changed.
*
* @return the {@link ValidationFailure#getCode() code}.
*/
protected String getCode() {
return getClass().getSimpleName();
}
@Override
public final ValidationFailure validate(V value) {
return validate(value, null);
}
/**
* This method determines if this {@link ValueValidator} is dynamic. Here dynamic means that the validation
* of the same input may not always return the same validation result (e.g. it holds references to instances that have
* dynamic impact on the validation).
*
* @return {@code true} if this {@link ValueValidator} is dynamic, {@code false} otherwise.
*/
public boolean isDynamic() {
return false;
}
/**
* @return {@code true} if this is a validator for mandatory fields (that will not accept {@code null} or empty
* values), {@code false} otherwise.
*/
public final boolean isMandatory() {
Boolean mandatory = getProperty(PROPERTY_MANDATORY);
if (Boolean.TRUE.equals(mandatory)) {
return true;
}
return false;
}
/**
* This is a convenience method delegating to {@link net.sf.mmm.util.nls.api.NlsBundleFactory#createBundle(Class)}.
*
* @param is the generic type of the requested {@link NlsBundle}.
* @param bundleInterface the interface of the requested {@link NlsBundle}. Has to be a sub-interface of
* {@link NlsBundle} with according methods.
* @return an instance of the requested {@link NlsBundle} interface.
* @since 3.1.0
*/
protected BUNDLE createBundle(Class bundleInterface) {
return NlsAccess.getBundleFactory().createBundle(bundleInterface);
}
/**
* Gets the value of a property.
*
* @param the generic type of the requested property.
* @param property the {@link TypedProperty}.
* @return the requested value or {@code null} if undefined.
* @since 7.1.0
*/
public
P getProperty(TypedProperty
property) {
return null;
}
/**
* @param validator the {@link AbstractValidator validator} to check.
* @return {@code true} if the given {@link AbstractValidator validator} is {@link #equals(Object) equal} to this
* validator or one of its descendents, {@code false} otherwise.
*/
public boolean contains(AbstractValidator validator) {
return equals(validator);
}
/**
* @param validators the {@link AbstractValidator validators} to append.
* @return a new {@link ComposedValidator} instance composing the current validator ({@code this}) with the given
* validator.
*/
@SuppressWarnings("unchecked")
public AbstractValidator append(AbstractValidator... validators) {
Objects.requireNonNull(validators, "validators");
if (validators.length == 0) {
return this;
}
if (validators.length == 1) {
if (validators[0] == ValidatorNone.getInstance()) {
return this;
}
return new ComposedValidator<>(this, validators[0]);
}
AbstractValidator[] array = new AbstractValidator[validators.length + 1];
array[0] = this;
System.arraycopy(validators, 0, validators, 1, validators.length);
return new ComposedValidator<>(array);
}
@Override
public abstract boolean equals(Object obj);
@Override
public abstract int hashCode();
}