IReport

All Known Implementing Classes:

IReport.Impl
```
public interface IReport
```
Common interface for reports of problems found during the generation of lexical analyzers or parsers

Author:

Stéphane Lescuyer

See Also:

of(String, Severity, CExtent), of(String, Severity, PExtent, PExtent.Hole), of(String, Severity, Located)

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`IReport.Impl` A default implementation for `IReport`
`static class`	`IReport.Severity` Enum describing the severity of the reported problem

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default String`	`display()` The default implementation displays the severity, the message, and the source location of the reported problem, in an Emacs-like fashion.
`int`	`getColumn()`
`String`	`getFilename()`
`int`	`getLength()`
`int`	`getLine()`
`String`	`getMessage()`
`int`	`getOffset()`
`IReport.Severity`	`getSeverity()`
`static IReport`	`of(String message, IReport.Severity severity, CExtent extent)`
`static IReport`	`of(String message, IReport.Severity severity, Located<?> loc)`
`static IReport`	`of(String message, IReport.Severity severity, PExtent extent, PExtent.Hole hole)`

- Method Detail
  - getMessage
```
String getMessage()
```
    Returns:
    
    a user-friendly message describing the report
  - getFilename
```
String getFilename()
```
    Returns:
    
    the path name of the file where the problem should be reported
  - getOffset
```
int getOffset()
```
    Returns:
    
    the absolute offset of the range where the problem should be reported (0-based)
  - getLine
```
int getLine()
```
    Returns:
    
    the line number where the problem should be reported (1-based)
  - getColumn
```
int getColumn()
```
    Returns:
    
    the column number where the problem should be reported (0-based)
  - getLength
```
int getLength()
```
    Returns:
    
    the length of the range where the problem should be reported, in characters
  - getSeverity
```
IReport.Severity getSeverity()
```
    Returns:
    
    the severity of the problem
  - of
```
static IReport of(String message,
                  IReport.Severity severity,
                  CExtent extent)
```
    Parameters:
    
    message -
    
    severity -
    
    extent -
    
    Returns:
    
    a report with the given message and severity, whose location is the one of extent
  - of
```
static IReport of(String message,
                  IReport.Severity severity,
                  PExtent extent,
                  PExtent.Hole hole)
```
    Parameters:
    
    message -
    
    severity -
    
    extent -
    
    hole -
    
    Returns:
    
    a report with the given message and severity, whose location is the one of hole in extent
  - of
```
static IReport of(String message,
                  IReport.Severity severity,
                  Located<?> loc)
```
    Parameters:
    
    message -
    
    severity -
    
    loc -
    
    Returns:
    
    a report with the given message and severity, at the location of the object loc
  - display
```
default String display()
```
    The default implementation displays the severity, the message, and the source location of the reported problem, in an Emacs-like fashion.
    It can be overridden by implementers.
    
    Returns:
    
    a string fully describing the report

Interface IReport

Nested Class Summary

Method Summary

Method Detail

getMessage

getFilename

getOffset

getLine

getColumn

getLength

getSeverity

of

of

of

display