play.data.validation

Class ValidationError

java.lang.Object

play.data.validation.ValidationError

public class ValidationError
extends java.lang.Object

A form validation error.

Constructor Summary

Constructors

Constructor and Description
ValidationError(java.lang.String key, java.util.List<java.lang.String> messages, java.util.List<java.lang.Object> arguments) Constructs a new ValidationError.
ValidationError(java.lang.String key, java.lang.String message) Constructs a new ValidationError.
ValidationError(java.lang.String key, java.lang.String message, java.util.List<java.lang.Object> arguments) Constructs a new ValidationError.

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.Object>	arguments() Returns the error arguments.
java.lang.String	format(Messages messagesObj) Returns the formatted error message (message + arguments) in the given Messages.
java.lang.String	key() Returns the error key.
java.lang.String	message() Returns the error message.
java.util.List<java.lang.String>	messages() Returns the error messages.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidationError

public ValidationError(java.lang.String key,
                       java.lang.String message)

Constructs a new ValidationError.

Parameters:

key - the error key

message - the error message

ValidationError

public ValidationError(java.lang.String key,
                       java.lang.String message,
                       java.util.List<java.lang.Object> arguments)

Constructs a new ValidationError.

Parameters:

key - the error key

message - the error message

arguments - the error message arguments

ValidationError

public ValidationError(java.lang.String key,
                       java.util.List<java.lang.String> messages,
                       java.util.List<java.lang.Object> arguments)

Constructs a new ValidationError.

Parameters:

key - the error key

messages - the list of error messages

arguments - the error message arguments

Method Detail

key

public java.lang.String key()

Returns the error key.

Returns:

the error key of the message.

message

public java.lang.String message()

Returns the error message.

Returns:

the last message in the list of messages.

messages

public java.util.List<java.lang.String> messages()

Returns the error messages.

Returns:

a list of messages.

arguments

public java.util.List<java.lang.Object> arguments()

Returns the error arguments.

Returns:

a list of error arguments.

format

public java.lang.String format(Messages messagesObj)

Returns the formatted error message (message + arguments) in the given Messages.

Parameters:

messagesObj - the play.i18n.Messages object containing the language.

Returns:

the results of messagesObj.at(messages, arguments).

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object