org.millscript.commons.alert
Interface AlertOrigin

public interface AlertOrigin

This interface describes methods for providing the origin information for an Alert.

Method Summary

int	getLineNumber() Returns the line number within the origin that the alert should be reported with.
java.lang.String	getOrigin() Returns the origin for the alert.
void	setContext(java.lang.String s, int n) Sets the context for the decorating an alert.
void	setLineNumber(int n) Sets the line number to decorate an alert with.
void	setOrigin(java.lang.String o) Sets the origin message to decorate an alet with.

Method Detail

getLineNumber

int getLineNumber()

Returns the line number within the origin that the alert should be reported with.

Returns:

the line number for the alert

getOrigin

java.lang.String getOrigin()

Returns the origin for the alert.

Returns:

the origin for the alert

setContext

void setContext(java.lang.String s,
                int n)

Sets the context for the decorating an alert. This method is a convenience to save calling the line number and origin methods separately.

Parameters:

s - the origin to decorate an alert with

n - the line number to decorate an alert with

setLineNumber

void setLineNumber(int n)

Sets the line number to decorate an alert with.

Parameters:

n - the line number to decorate an alert with

setOrigin

void setOrigin(java.lang.String o)

Sets the origin message to decorate an alet with.

Parameters:

o - the origin message to decorate an alert with