play.data.validation.Error Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of framework Show documentation

RePlay is a fork of the Play1 framework, created by Codeborne.

There is a newer version: 2.6.3

package play.data.validation;

import net.sf.oval.ConstraintViolation;
import play.i18n.Messages;

import javax.annotation.CheckReturnValue;
import javax.annotation.Nonnull;
import java.util.Collection;

import static java.util.Collections.emptyList;

/**
 * A validation error
 */
public class Error {

    private final String message;
    private final String key;
    private final Collection variables;

    public Error(String key, String message, Collection variables) {
        this.message = message;
        this.key = key;
        this.variables = variables;
    }
    
    /**
     * @return The translated message
     */
    public String message() {
        return message(key);
    }
    
    /**
     * @return The field name
     */
    public String getKey() {
        return key;
    }

    /**
     * @return The variables
     */
    public Collection getVariables() {
        return variables;
    }
    
    /**
     * @param key Alternate field name (default to java variable name)
     * @return The translated message
     */
    public String message(String key) {
        key = Messages.get(key);
        Object[] args = new Object[variables.size() + 1];
        args[0] = key;
        int i = 1;
        for (Object variable : variables) {
            args[i++] = variable;
        }
        return Messages.get(message, args);
    }

    @Override
    public String toString() {
        return message();
    }

    String getMessageKey() {
        return message;
    }

    @Nonnull
    @CheckReturnValue
    static Error toValidationError(String key, ConstraintViolation violation) {
        Collection variables = violation.getMessageVariables() == null ? emptyList() : violation.getMessageVariables().values();
        return new Error(key, violation.getMessage(), variables);
    }
}