emulib.plugins.compiler

Class Message

java.lang.Object

emulib.plugins.compiler.Message

public class Message
extends Object

This class provides the message object that will be passed when the compiler wishes to print a message. Compilers that generate messages should use this object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Message.MessageType Message type.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ERROR_FORMAT
static String	INFO_FORMAT
static String	POSITION_FORMAT
static String	SOURCE_FILE_FORMAT
static String	WARNING_FORMAT

Constructor Summary

Constructors

Constructor and Description
Message(Message.MessageType type, String message) This constructor creates the Message object.
Message(Message.MessageType message_type, String message, int error_code) This constructor creates the Message object.
Message(Message.MessageType message_type, String message, int line, int column, String sourceFile, int error_code) This constructor creates the Message object.
Message(Message.MessageType message_type, String message, String sourceFile, int errorCode) This constructor creates the Message object.
Message(String message) This constructor creates the Message object.

Method Summary

Modifier and Type	Method and Description
int	getColumn() Get column of the source code that the message belongs to.
int	getErrorCode()
String	getFormattedMessage() Return formatted string that represents this Message object.
int	getLine() Get line of the source code that the message belongs to.
String	getMessage() Get the text of the message.
Message.MessageType	getMessageType() Get the type of the message.
String	getSourceFile()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

INFO_FORMAT

public static final String INFO_FORMAT

See Also:

Constant Field Values

ERROR_FORMAT

public static final String ERROR_FORMAT

See Also:

Constant Field Values

WARNING_FORMAT

public static final String WARNING_FORMAT

See Also:

Constant Field Values

POSITION_FORMAT

public static final String POSITION_FORMAT

See Also:

Constant Field Values

SOURCE_FILE_FORMAT

public static final String SOURCE_FILE_FORMAT

See Also:

Constant Field Values

Constructor Detail

Message

public Message(Message.MessageType message_type,
               String message,
               int line,
               int column,
               String sourceFile,
               int error_code)

This constructor creates the Message object. Messages are created by compiler.

Parameters:

message_type - Type of the message.

message - Text of the message

line - Line in the source code

column - Column in the source code

sourceFile - Name of the file that the message belongs to

error_code - Error code of the message (compiler-specific)

Message

public Message(String message)

This constructor creates the Message object. Messages are created by compiler.

Parameters:

message - Text of the message

Message

public Message(Message.MessageType type,
               String message)

This constructor creates the Message object. Messages are created by compiler.

Parameters:

type - Type of the message.

message - Text of the message

Message

public Message(Message.MessageType message_type,
               String message,
               int error_code)

This constructor creates the Message object. Messages are created by compiler.

Parameters:

message_type - Type of the message.

message - Text of the message

error_code - Error-specific code

Message

public Message(Message.MessageType message_type,
               String message,
               String sourceFile,
               int errorCode)

This constructor creates the Message object. Messages are created by compiler.

Parameters:

message_type - Type of the message.

message - Text of the message

sourceFile - Name of the file that the message belongs to

errorCode - Error-specific code

Method Detail

getErrorCode

public int getErrorCode()

getSourceFile

public String getSourceFile()

getFormattedMessage

public String getFormattedMessage()

Return formatted string that represents this Message object.

Returns:

formatted message

getLine

public int getLine()

Get line of the source code that the message belongs to.

Returns:

the line, starting from 0. Negative values indicate that this value is not valid.

getColumn

public int getColumn()

Get column of the source code that the message belongs to.

Returns:

the column, starting from 0. Negative values indicate that this value is not valid.

getMessage

public String getMessage()

Get the text of the message.

Returns:

text of the message

getMessageType

public Message.MessageType getMessageType()

Get the type of the message.

Returns:

the message type

toString

public String toString()

Overrides:

toString in class Object