Module com.github.hazendaz.parent

Package org.csveed.report

Class GeneralError

java.lang.Object

org.csveed.report.AbstractCsvError

org.csveed.report.GeneralError

All Implemented Interfaces:

CsvError

public class GeneralError
extends AbstractCsvError

The Class GeneralError.

Constructor Summary

Constructors

Constructor	Description
GeneralError(String message)	Instantiates a new general error.

Method Summary

Modifier and Type	Method	Description
int	getLineNumber()	Returns the line number where the error occurred, zero-based.
List<String>	getPrintableLines()	Returns all lines, first the message, then the content and focus line, if available.
List<RowPart>	getRowParts()	Gets the content line where the error occurred, if available.

Methods inherited from class org.csveed.report.AbstractCsvError

getMessage, getMessageAsList

Methods inherited from class java.lang.Object

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

Constructor Details

GeneralError

public GeneralError(String message)

Instantiates a new general error.

Parameters:

message - the message

Method Details

getPrintableLines

public List<String> getPrintableLines()

Description copied from interface: CsvError

Returns all lines, first the message, then the content and focus line, if available. These lines are usable to print with a monospaced font, since the focus line will show in the line above where the error occurred. If lines are needed for the browser, use CsvError.getRowParts().

Returns:

all lines, in printable format. Will always contain at least one line.

getRowParts

public List<RowPart> getRowParts()

Description copied from interface: CsvError

Gets the content line where the error occurred, if available. The line is split into RowPart entries. Every RowPart knows about itself when it must be highlighted. This method is useful for reporting on the error in another format, for example HTML or PDF, since you can control the highlighting.

Returns:

the content line split into RowPart entries. Will be an empty list if not available.

getLineNumber

public int getLineNumber()

Description copied from interface: CsvError

Returns the line number where the error occurred, zero-based. Will be -1 if not applicable.

Returns:

line number where the error occurred