to.etc.domui.dom.errors

Class UIMessage

java.lang.Object

to.etc.domui.dom.errors.UIMessage

public class UIMessage
extends Object

A single error message for a component. The message consists of a message code and optional parameters, and usually hard-refers to the component where the error occured. Global errors exist also; these have a null component and must be shown in whatever error container exists.

Author:

Frits Jalvingh Created on Jun 11, 2008

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UIMessage(NodeBase errorNode, String errorLocation, MsgType type, BundleRef br, String code, Object[] parameters) Create an error message container.
protected	UIMessage(NodeBase errorNode, String errorLocation, MsgType type, BundleRef br, String code, Object[] parameters, String group)

Method Summary

Modifier and Type	Method and Description
static UIMessage	create(NodeBase n, ProblemInstance pi)
boolean	equals(Object obj)
static UIMessage	error(BundleRef ref, String code, Object... param)
static UIMessage	error(CodeException x)
static UIMessage	error(NodeBase node, BundleRef ref, String code, Object... param)
static UIMessage	error(NodeBase node, String errorLocation, BundleRef ref, String code, Object... param)
static UIMessage	error(String errorLocation, BundleRef ref, String code, Object... param)
static UIMessage	error(UIException x)
BundleRef	getBundle() Returns the message bundle the code is in, or null if the code is a global message code (deprecated).
String	getCode()
String	getErrorLocation() When set this is used in error messages as an indication of which input field contains the error.
NodeBase	getErrorNode()
String	getGroup()
String	getMessage() Returns the message part of the error message, properly localized for the request's locale.
String	getMessageKey() Return a unique key for the message as "bundle name" '#' "code".
Object[]	getParameters()
MsgType	getType()
UIMessage	group(String name)
int	hashCode()
static UIMessage	info(BundleRef ref, String code, Object... param)
UIMessage	location(String errorLocation) Chaining setter for setErrorLocation.
void	setErrorLocation(String errorLocation)
void	setErrorNode(NodeBase errorNode)
String	toString()
static UIMessage	warning(BundleRef ref, String code, Object... param)
static UIMessage	warning(NodeBase node, BundleRef ref, String code, Object... param)
static UIMessage	warning(NodeBase node, String errorLocation, BundleRef ref, String code, Object... param)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UIMessage

protected UIMessage(@Nullable
                    NodeBase errorNode,
                    @Nullable
                    String errorLocation,
                    @Nonnull
                    MsgType type,
                    @Nonnull
                    BundleRef br,
                    @Nonnull
                    String code,
                    @Nullable
                    Object[] parameters)

Create an error message container.

Parameters:

errorNode - If not-null this is the node that "owns" the error. This node will show a visual indication of the fact that it contains an error.

errorLocation - If not-null this is a user-understandable name of the input item that contains the error. It usually is the "label" associated with the problem.

type - The type of message: error, warning or info.

br - The bundle containing the message for the code. If this is null (deprecated) the "global bundle set" is used *WHICH IS DEPRECATED*.

code - The code for the message.

parameters - If needed a set of parameters to render into the message.

UIMessage

protected UIMessage(@Nullable
                    NodeBase errorNode,
                    @Nullable
                    String errorLocation,
                    @Nonnull
                    MsgType type,
                    @Nonnull
                    BundleRef br,
                    @Nonnull
                    String code,
                    @Nullable
                    Object[] parameters,
                    @Nullable
                    String group)

Method Detail

getMessageKey

public String getMessageKey()

Return a unique key for the message as "bundle name" '#' "code". The bundle name is defined as the bundle's class package + '.' + message file name without extension

Returns:

group

@Nonnull
public UIMessage group(@Nonnull
                                String name)

getGroup

@Nullable
public String getGroup()

getCode

public String getCode()

getBundle

@Nullable
public BundleRef getBundle()

Returns the message bundle the code is in, or null if the code is a global message code (deprecated).

Returns:

getParameters

@Nonnull
public Object[] getParameters()

getErrorNode

@Nullable
public NodeBase getErrorNode()

setErrorNode

public void setErrorNode(@Nullable
                         NodeBase errorNode)

getType

@Nonnull
public MsgType getType()

getErrorLocation

@Nullable
public String getErrorLocation()

When set this is used in error messages as an indication of which input field contains the error. It usually contains the value for the "label" of the control.

Returns:

setErrorLocation

public void setErrorLocation(String errorLocation)

location

@Nonnull
public UIMessage location(@Nullable
                                   String errorLocation)

Chaining setter for setErrorLocation.

Parameters:

errorLocation -

Returns:

getMessage

@Nonnull
public String getMessage()

Returns the message part of the error message, properly localized for the request's locale.

Returns:

create

@Nonnull
public static UIMessage create(@Nullable
                                        NodeBase n,
                                        @Nonnull
                                        ProblemInstance pi)

error

@Nonnull
public static UIMessage error(@Nonnull
                                       CodeException x)

error

@Nonnull
public static UIMessage error(@Nonnull
                                       UIException x)

error

@Nonnull
public static UIMessage error(NodeBase node,
                                       String errorLocation,
                                       @Nonnull
                                       BundleRef ref,
                                       @Nonnull
                                       String code,
                                       Object... param)

error

@Nonnull
public static UIMessage error(String errorLocation,
                                       @Nonnull
                                       BundleRef ref,
                                       @Nonnull
                                       String code,
                                       Object... param)

error

@Nonnull
public static UIMessage error(NodeBase node,
                                       @Nonnull
                                       BundleRef ref,
                                       @Nonnull
                                       String code,
                                       Object... param)

error

@Nonnull
public static UIMessage error(@Nonnull
                                       BundleRef ref,
                                       @Nonnull
                                       String code,
                                       Object... param)

warning

@Nonnull
public static UIMessage warning(NodeBase node,
                                         String errorLocation,
                                         @Nonnull
                                         BundleRef ref,
                                         @Nonnull
                                         String code,
                                         Object... param)

warning

@Nonnull
public static UIMessage warning(NodeBase node,
                                         @Nonnull
                                         BundleRef ref,
                                         @Nonnull
                                         String code,
                                         Object... param)

warning

@Nonnull
public static UIMessage warning(@Nonnull
                                         BundleRef ref,
                                         @Nonnull
                                         String code,
                                         Object... param)

info

@Nonnull
public static UIMessage info(@Nonnull
                                      BundleRef ref,
                                      @Nonnull
                                      String code,
                                      Object... param)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

@Nonnull
public String toString()

Overrides:

toString in class Object