net.sf.mmm.util.validation.base

Class ValidationFailureSuccess

java.lang.Object

net.sf.mmm.util.validation.base.ValidationFailureSuccess

All Implemented Interfaces:

Serializable, AttributeReadMessage, AttributeReadMessageCode, AttributeReadUuid, Message, ValidationFailure

public final class ValidationFailureSuccess
extends Object
implements ValidationFailure

Placeholder implementation of ValidationFailure representing success used as internal representation where null is not suitable.

Since:

7.1.0

Author:

hohwille

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static ValidationFailureSuccess	INSTANCE The singleton instance.
private static long	serialVersionUID

Fields inherited from interface net.sf.mmm.util.lang.api.Message

TYPE_INFORMATION, TYPE_TECHNICAL_ERROR, TYPE_USER_ERROR, TYPE_VALIDATION_FAILURE, TYPE_WARNING

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ValidationFailureSuccess() The constructor.

Method Summary

Modifier and Type	Method and Description
String	getCode() This method gets the code of this ValidationFailure.
String	getDetails() This method gets optional details for this message.
String	getMessage() This method gets the message of the validation failure.
String	getMessage(Locale locale) This method gets the message localized for the given Locale.
String	getSource() This method gets the (optional) source of the validation.
String	getType() This method gets the type of this Message.
UUID	getUuid() This method gets the UUID of this object.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

INSTANCE

public static ValidationFailureSuccess INSTANCE

The singleton instance.

Constructor Detail

ValidationFailureSuccess

private ValidationFailureSuccess()

The constructor.

Method Detail

getDetails

public String getDetails()

Description copied from interface: Message

This method gets optional details for this message. E.g. in case of an exception this can be the stacktrace.

Specified by:

getDetails in interface Message

Returns:

the details or null if no additional details are available.

getType

public String getType()

Description copied from interface: Message

This method gets the type of this Message. This should be one of the following options:

• "ValidationFailure" - for a ValidationFailure.
• "UserError" - for an error caused by the end-user (e.g. by providing invalid data). Unlike Message.TYPE_VALIDATION_FAILURE this is an actual error that has been detected after a successful validation.
• "TechnicalError" - for an error related to a technical problem (e.g. programming failure such as NullPointerException or operational error like ConnectException).
• "Warning" - for a warning such as "The hit-list for your query has been truncated."). In such case it should be possible to continue the use-case or operation normally.
• "Information" - for additional information - e.g. a hint.

Specified by:

getType in interface Message

Returns:

the message type.

getUuid

public UUID getUuid()

Description copied from interface: Message

This method gets the UUID of this object. When the object is created, a UUID is generated. In case the object is created from another object that already has a UUID, the existing UUID will be used (e.g. for chained exceptions).
The UUID will appear in a stacktrace but NOT in the message. It will therefore be written to log-files if the NlsThrowable is logged. If you supply the UUID to the end-user in an error panel or popup (see Message), he can provide it with the problem report so an administrator or software developer can easily find the stacktrace in the log-files.

Specified by:

getUuid in interface AttributeReadUuid

Specified by:

getUuid in interface Message

Returns:

the UUID if this Message. Will typically only be available if type is Message.TYPE_TECHNICAL_ERROR or Message.TYPE_USER_ERROR. Will be null if not available.

getSource

public String getSource()

Description copied from interface: ValidationFailure

This method gets the (optional) source of the validation. It describes the origin of the given value. This may be the filename where the value was read from, an XPath where the value was located in an XML document, etc. It can be used to enrich messages displayed to end-users. This will help to find the problem easier.

Specified by:

getSource in interface Message

Specified by:

getSource in interface ValidationFailure

Returns:

the source or null if NOT available.

getMessage

public String getMessage()

Description copied from interface: ValidationFailure

This method gets the message of the validation failure. This is a localized text displayed to end-users. It should explain the reason of the failure in a understandable but short form.
Some examples are "This field may not be blank." or "This value has to be in the range from 5 to 9.". Depending on the usage the message may also contain the name of the field or other context information in order to determine the source of the problem.

Specified by:

getMessage in interface AttributeReadMessage

Specified by:

getMessage in interface ValidationFailure

Returns:

the message.

See Also:

Throwable.getMessage(), NlsThrowable, Message

getMessage

public String getMessage(Locale locale)

Description copied from interface: ValidationFailure

This method gets the message localized for the given Locale.
ATTENTION:
This method is designed for server applications with NLS. On client side (e.g. for GWT clients) only a single locale may be supported at a time and this method will behave like ValidationFailure.getMessage() ignoring the lcoale.

Specified by:

getMessage in interface Message

Specified by:

getMessage in interface ValidationFailure

Parameters:

locale - is the Locale.

Returns:

the message.

getCode

public String getCode()

Description copied from interface: ValidationFailure

This method gets the code of this ValidationFailure. The code is a stable identifier that indicates the type of the failure. It can be used for automated testing in order to make the test-cases independent from the actual message texts so they are maintainable and will not break e.g. if typos are fixed in the messages.

Specified by:

getCode in interface AttributeReadMessageCode

Specified by:

getCode in interface ValidationFailure

Returns:

the failure code.

See Also:

Throwable.getMessage(), NlsThrowable, Message