org.millscript.millscript.alert
Class Alerts

java.lang.Object
  org.millscript.millscript.alert.Alerts

public class Alerts
extends java.lang.Object

These are utility alerts for MillScript.

Constructor Summary

Alerts()

Method Summary

static org.millscript.commons.alert.Alert	autoload(java.lang.String comp, java.lang.String exp) Convenience method for constructing a new alert with the specified complaint and explanation in the autoloading phase.
static org.millscript.commons.alert.Alert	compile(java.lang.String comp, java.lang.String exp) Convenience method for constructing a new alert with the specified complaint and explanation in the compile phase.
static org.millscript.commons.alert.Alert	eval(java.lang.String comp, java.lang.String exp) Convenience method for constructing a new alert with the specified complaint and explanation in the evaluation phase.
static org.millscript.commons.alert.Alert	fault(java.lang.String msg) Utility method for internal fault mishaps.
static org.millscript.commons.alert.Alert	parse(java.lang.String comp, java.lang.String exp) Convenience method for constructing a new alert with the specified complaint and explanation in the parsing phase.
static org.millscript.commons.alert.Alert	template(java.lang.String comp, java.lang.String exp) Convenience method for constructing a new alert with the specified complaint and explanation in the template loading phase.
static org.millscript.commons.alert.Alert	unimplemented(java.lang.String msg) Utility method for unimplemented mishaps, where you only need to display a simple message.

Methods inherited from class java.lang.Object

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

Constructor Detail

Alerts

public Alerts()

Method Detail

autoload

public static org.millscript.commons.alert.Alert autoload(java.lang.String comp,
                                                          java.lang.String exp)

Convenience method for constructing a new alert with the specified complaint and explanation in the autoloading phase.

Parameters:

comp - the complaint

exp - the explanation for the complaint

Returns:

a new alert with the specified complaint and explanation

compile

public static org.millscript.commons.alert.Alert compile(java.lang.String comp,
                                                         java.lang.String exp)

Convenience method for constructing a new alert with the specified complaint and explanation in the compile phase.

Parameters:

comp - the complaint

exp - the explanation for the complaint

Returns:

a new alert with the specified complaint and explanation

eval

public static org.millscript.commons.alert.Alert eval(java.lang.String comp,
                                                      java.lang.String exp)

Convenience method for constructing a new alert with the specified complaint and explanation in the evaluation phase.

Parameters:

comp - the complaint

exp - the explanation for the complaint

Returns:

a new alert with the specified complaint and explanation

parse

public static org.millscript.commons.alert.Alert parse(java.lang.String comp,
                                                       java.lang.String exp)

Convenience method for constructing a new alert with the specified complaint and explanation in the parsing phase.

Parameters:

comp - the complaint

exp - the explanation for the complaint

Returns:

a new alert with the specified complaint and explanation

template

public static org.millscript.commons.alert.Alert template(java.lang.String comp,
                                                          java.lang.String exp)

Convenience method for constructing a new alert with the specified complaint and explanation in the template loading phase.

Parameters:

comp - the complaint

exp - the explanation for the complaint

Returns:

a new alert with the specified complaint and explanation

fault

public static org.millscript.commons.alert.Alert fault(java.lang.String msg)

Utility method for internal fault mishaps. This is just a convenience for generating an internat fault alert.

Parameters:

msg - the mishap complaint

Returns:

a new alert for the specified fault

unimplemented

public static org.millscript.commons.alert.Alert unimplemented(java.lang.String msg)

Utility method for unimplemented mishaps, where you only need to display a simple message.

Parameters:

msg - the unimplemented feature message

Returns:

a new alert for the unimplemented feature