to.etc.domui.logic.errors

Class Problem

java.lang.Object

to.etc.domui.logic.errors.Problem

Direct Known Subclasses:

MandatoryProblem

@DefaultNonNull
 @Immutable
public class Problem
extends Object

EXPERIMENTAL Definition of a possible error/message. The message is uniquely identifyable by a package name combined with a message code. The package name is obtained from a class passed in when defining the problem, and is used to retrieve the resource bundle for obtaining the message's string. The bundle is hard defined as residing in the specified package with a name of "messages".

A problem is switched "on" or "off" on any part of a model. Any model part (model, instance, instance-property) can have any list of switched-on problems, but every Problem instance can exist only once in each of those. A problem can be reported as-is, but can also have parameters that will be used to construct the message. These parameters however are not part of the identity of the problem; even when parameters differ can you not report the same problem multiple times on the same model part.

Author:

Frits Jalvingh Created on Nov 7, 2014

Constructor Summary

Constructors

Modifier	Constructor and Description
	Problem(Class<?> anchor, String code)
protected	Problem(Class<?> anchor, String code, MsgType type, boolean repeatable)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static Problem	error(Class<?> anchor, String code)
static Problem	errorList(Class<?> anchor, String code)
BundleRef	getBundle()
String	getCode()
String	getMessageKey() Return a unique key for the message as "bundle name" '#' "code".
MsgType	getSeverity()
int	hashCode()
boolean	isRepeatable()
<T> void	off(ProblemModel errors, T instance) Switch off this error: remove it from the error(s) list.
<T,P> void	off(ProblemModel errors, T instance, PropertyMetaModel<P> property)
<T,P> void	off(ProblemModel errors, T instance, String property)
<T> ProblemInstance	on(ProblemModel errors, T instance) Report this error on a specific instance only.
<T,P> ProblemInstance	on(ProblemModel errors, T instance, PropertyMetaModel<P> property) Report this error on the specified instance's property.
<T> ProblemInstance	on(ProblemModel errors, T instance, String property)
String	toString()
static Problem	warning(Class<?> anchor, String code)
static Problem	warningList(Class<?> anchor, String code)
<T> ProblemInstance	when(ProblemModel errors, T instance, boolean condition)
<T> ProblemInstance	when(ProblemModel errors, T instance, String property, boolean condition)

Methods inherited from class java.lang.Object

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

Constructor Detail

Problem

public Problem(Class<?> anchor,
               String code)

Problem

protected Problem(Class<?> anchor,
                  String code,
                  MsgType type,
                  boolean repeatable)

Method Detail

warning

public static Problem warning(Class<?> anchor,
                              String code)

warningList

public static Problem warningList(Class<?> anchor,
                                  String code)

error

public static Problem error(Class<?> anchor,
                            String code)

errorList

public static Problem errorList(Class<?> anchor,
                                String code)

isRepeatable

public boolean isRepeatable()

getCode

public String getCode()

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:

getSeverity

public MsgType getSeverity()

getBundle

public BundleRef getBundle()

off

public <T> void off(@Nonnull
                    ProblemModel errors,
                    @Nonnull
                    T instance)

Switch off this error: remove it from the error(s) list.

Parameters:

errors -

off

public <T,P> void off(@Nonnull
                      ProblemModel errors,
                      @Nonnull
                      T instance,
                      @Nonnull
                      PropertyMetaModel<P> property)

off

public <T,P> void off(@Nonnull
                      ProblemModel errors,
                      @Nonnull
                      T instance,
                      @Nonnull
                      String property)

on

public <T> ProblemInstance on(@Nonnull
                              ProblemModel errors,
                              @Nonnull
                              T instance)

Report this error on a specific instance only.

Parameters:

errors -

instance -

Returns:

on

@Nonnull
public <T,P> ProblemInstance on(@Nonnull
                                         ProblemModel errors,
                                         @Nonnull
                                         T instance,
                                         @Nonnull
                                         PropertyMetaModel<P> property)

Report this error on the specified instance's property.

Parameters:

errors -

instance -

property -

Returns:

on

@Nonnull
public <T> ProblemInstance on(@Nonnull
                                       ProblemModel errors,
                                       @Nonnull
                                       T instance,
                                       @Nonnull
                                       String property)

when

public <T> ProblemInstance when(@Nonnull
                                ProblemModel errors,
                                @Nonnull
                                T instance,
                                @Nonnull
                                String property,
                                boolean condition)

when

public <T> ProblemInstance when(@Nonnull
                                ProblemModel errors,
                                @Nonnull
                                T instance,
                                boolean condition)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable
                      Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object