org.dmd.dmc.rules

Class DmcRuleException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.dmd.dmc.rules.DmcRuleException

All Implemented Interfaces:

Serializable

public class DmcRuleException
extends Exception

The DmcRuleException is generally thrown by validation rules defined as part of your dark-matter schema. Not all categories of rules throw exceptions.

The primary reason for the existence of the DmcRuleException is to allow for shared rules between full Java and restricted Java environments (like GWT). A DmcRuleException will always have an error message in whatever base language you prefer, but it can always be adapted for display in other languages because it provides mechanisms to define a unique message key as well as any parameters that may be embedded in the message.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DmcRuleException(String baseMessage, RuleIF ri) Instantiates a new DmcRuleException.
DmcRuleException(String baseMessage, RuleIF ri, String mk) Instantiates a new, translatable DmcRuleException.
DmcRuleException(String baseMessage, RuleIF ri, String mk, String p1) Instantiates a new, translatable DmcRuleException with a single message parameter.
DmcRuleException(String baseMessage, RuleIF ri, String mk, String p1, String p2) Instantiates a new, translatable DmcRuleException with two message parameters.
DmcRuleException(String baseMessage, RuleIF ri, String mk, String p1, String p2, String p3) Instantiates a new, translatable DmcRuleException with three message parameters.

Method Summary

Modifier and Type	Method and Description
String	getMessageKey()
String	getParameter(int index)
RuleIF	getRule()
boolean	immediateHalt()
void	immediateHalt(boolean f) Sets the immediate halt flag as specified.
SourceInfo	source()
void	source(SourceInfo si)
String	toString()

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Constructor Detail

DmcRuleException

public DmcRuleException(String baseMessage,
                        RuleIF ri)

Instantiates a new DmcRuleException.

Parameters:

baseMessage - the basic message.

ri - the rule that threw the exception.

DmcRuleException

public DmcRuleException(String baseMessage,
                        RuleIF ri,
                        String mk)

Instantiates a new, translatable DmcRuleException.

Parameters:

baseMessage - the basic message.

ri - the rule that threw the exception.

mk - the message key.

DmcRuleException

public DmcRuleException(String baseMessage,
                        RuleIF ri,
                        String mk,
                        String p1)

Instantiates a new, translatable DmcRuleException with a single message parameter.

Parameters:

baseMessage - the basic message.

ri - the rule that threw the exception.

mk - the message key.

p1 - the first parameter.

DmcRuleException

public DmcRuleException(String baseMessage,
                        RuleIF ri,
                        String mk,
                        String p1,
                        String p2)

Instantiates a new, translatable DmcRuleException with two message parameters.

Parameters:

baseMessage - the basic message.

ri - the rule that threw the exception.

mk - the message key.

p1 - the first parameter.

p2 - the second parameter.

DmcRuleException

public DmcRuleException(String baseMessage,
                        RuleIF ri,
                        String mk,
                        String p1,
                        String p2,
                        String p3)

Instantiates a new, translatable DmcRuleException with three message parameters.

Parameters:

baseMessage - the basic message.

ri - the rule that threw the exception.

mk - the message key.

p1 - the first parameter.

p2 - the second parameter.

p3 - the third parameter.

Method Detail

source

public void source(SourceInfo si)

source

public SourceInfo source()

immediateHalt

public boolean immediateHalt()

Returns:

true if this rule that generated this exception wants no further processing to occur.

immediateHalt

public void immediateHalt(boolean f)

Sets the immediate halt flag as specified.

Parameters:

f - the flag value.

getRule

public RuleIF getRule()

Returns:

the rule that threw this exception.

getMessageKey

public String getMessageKey()

Returns:

the message key if it was provided and null otherwise.

getParameter

public String getParameter(int index)

Returns:

the specified message parameter or null if it doesn't exist.

toString

public String toString()

Overrides:

toString in class Throwable