Package eu.bandm.tools.message

Class PreMessage

java.lang.Object

eu.bandm.tools.message.PreMessage

public class PreMessage
extends Object

Represent the result of a test, for parameter validity or sim. In case of a failure, it contains the error text and its parameters for constructing an error message.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final Object[]	args
static final PreMessage	OKAY	Evident
(package private) final Optional<String>	text

Constructor Summary

Constructors

Constructor	Description
PreMessage(String text, Object... args)	Evident

Method Summary

Modifier and Type	Method	Description
<D> @Opt SimpleMessage<D>	asError(@Opt Location<D> location)	Convert to an error message with given location.
<D> @Opt SimpleMessage<D>	asSimpleMessage(Message.Kind kind, int level, @Opt Location<D> location)	Convert to a message with given kind, level, and location.
<D> @Opt SimpleMessage<D>	asWarning(@Opt Location<D> location)	Convert to a warning message with given location.
<D> @Opt SimpleMessage<D>	asWarning(@Opt Location<D> location, int level)	Convert to a warning message with given location and verbosity level.
@Opt RuntimeException	explode()	Throws an exception carrying this message, iff not OKay.
<D> @Opt RuntimeException	explode(@Opt Location<D> location)	Throws an exception carrying this message, iff not OKay.
boolean	isOkay()	Evident
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

text

final Optional<String> text

args

final Object[] args

OKAY

public static final PreMessage OKAY

Evident

Constructor Details

PreMessage

public PreMessage(String text,
 Object... args)

Evident

Method Details

isOkay

public boolean isOkay()

Evident

asError

@Opt
public <D> @Opt SimpleMessage<D> asError(@Opt
 @Opt Location<D> location)

Convert to an error message with given location.

asWarning

@Opt
public <D> @Opt SimpleMessage<D> asWarning(@Opt
 @Opt Location<D> location)

Convert to a warning message with given location.

asWarning

@Opt
public <D> @Opt SimpleMessage<D> asWarning(@Opt
 @Opt Location<D> location,
 int level)

Convert to a warning message with given location and verbosity level.

asSimpleMessage

@Opt
public <D> @Opt SimpleMessage<D> asSimpleMessage(Message.Kind kind,
 int level,
 @Opt
 @Opt Location<D> location)

Convert to a message with given kind, level, and location.

toString

public String toString()

Overrides:

toString in class Object

explode

@Opt
public @Opt RuntimeException explode()

Throws an exception carrying this message, iff not OKay.

Returns:

null iff the PreMessage does not reflect an error condiiton.

explode

@Opt
public <D> @Opt RuntimeException explode(@Opt
 @Opt Location<D> location)

Throws an exception carrying this message, iff not OKay.

Returns:

null iff the PreMessage does not reflect an error condiiton.