ej.tool.addon

Class Marker

java.lang.Object

ej.tool.addon.Marker

public class Marker
extends Object

A marker is an information set by a processor.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Marker.MarkerLevel An enumeration that represents possible marker levels.

Field Summary

Fields

Modifier and Type	Field and Description
static int	NO_LINE_NUMBER A constant to indicate there is no line number information in a marker.

Constructor Summary

Constructors

Constructor and Description
Marker(String message, File file, int line, Marker.MarkerLevel level) Instantiates a new marker with given message and level.
Marker(String message, File file, int line, Throwable cause, Marker.MarkerLevel level) Instantiates a new marker with given message, cause and level.
Marker(String message, Marker.MarkerLevel level) Instantiates a new marker with given message and level.
Marker(String message, Throwable cause, Marker.MarkerLevel level) Instantiates a new marker with given message, cause and level.
Marker(Throwable cause, Marker.MarkerLevel level) Instantiates a new marker with given cause and level.

Method Summary

Modifier and Type	Method and Description
Throwable	getCause() Gets the cause carried by this marker.
File	getFile() Gets the file pointed by this marker.
Marker.MarkerLevel	getLevel() Gets the level of this marker.
int	getLine() Gets the line number in the file pointed by this marker.
String	getMessage() Gets the message carried by this marker.

Methods inherited from class java.lang.Object

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

Field Detail

NO_LINE_NUMBER

public static final int NO_LINE_NUMBER

A constant to indicate there is no line number information in a marker.

See Also:

Constant Field Values

Constructor Detail

Marker

public Marker(String message,
              File file,
              int line,
              Marker.MarkerLevel level)

Instantiates a new marker with given message and level. Marker is attached to given file on given line number.

Parameters:

message - the message carried by the marker to create.

file - the file pointed by the marker to create.

line - the line number of the file pointed the marker to create.

level - the level of the marker to create.

Marker

public Marker(String message,
              File file,
              int line,
              Throwable cause,
              Marker.MarkerLevel level)

Instantiates a new marker with given message, cause and level. Marker is attached to given file on given line number.

Parameters:

message - the message carried by the marker to create.

file - the file pointed by the marker to create.

line - the line number of the file pointed the marker to create.

cause - the cause of this marker.

level - the level of the marker to create.

Marker

public Marker(String message,
              Marker.MarkerLevel level)

Instantiates a new marker with given message and level.

Parameters:

message - the message carried by the marker to create.

level - the level of the marker to create.

Marker

public Marker(String message,
              Throwable cause,
              Marker.MarkerLevel level)

Instantiates a new marker with given message, cause and level.

Parameters:

message - the message carried by the marker to create.

cause - the cause of this marker.

level - the level of the marker to create.

Marker

public Marker(Throwable cause,
              Marker.MarkerLevel level)

Instantiates a new marker with given cause and level.

Parameters:

cause - the cause of this marker.

level - the level of the marker to create.

Method Detail

getCause

public Throwable getCause()

Gets the cause carried by this marker.

Returns:

the cause carried by this marker, or null if there is no cause to this marker.

getFile

public File getFile()

Gets the file pointed by this marker.

Returns:

the file pointed by this marker, or null if no file is attached to this marker.

getLevel

public Marker.MarkerLevel getLevel()

Gets the level of this marker.

Returns:

the level of this marker.

getLine

public int getLine()

Gets the line number in the file pointed by this marker.

Returns:

the line number in the file pointed by this marker, or NO_LINE_NUMBER if there is no line number information.

getMessage

public String getMessage()

Gets the message carried by this marker.

Returns:

the message carried by this marker, or null if this marker has no message.