smartrics.rest.fitnesse.fixture.support

Interface CellFormatter<E>

Type Parameters:

E - the type of the cell

All Known Implementing Classes:

FitFormatter, SlimFormatter

public interface CellFormatter<E>

Formatter of the content of a cell.

Author:

smartrics

Method Summary

Modifier and Type	Method and Description
void	asLink(CellWrapper<E> cell, String resolvedUrl, String link, String text) formats the content as a hyperlink.
void	check(CellWrapper<E> valueCell, RestDataTypeAdapter adapter) formats a check cell.
void	exception(CellWrapper<E> cellWrapper, String exceptionMessage) formats a cell containing an exception.
void	exception(CellWrapper<E> cellWrapper, Throwable exception) formats a cell containing an exception.
String	fromRaw(String text) in SLIM cell content is HTML escaped - we abstract this method to delegate to formatter the cleaning of the content.
String	gray(String string) formats a cell with a gray background.
boolean	isDisplayActual()
String	label(String string) formats a cell label
void	right(CellWrapper<E> expected, RestDataTypeAdapter typeAdapter) formats a cell representing a right expectation.
void	setDisplayAbsoluteURLInFull(boolean displayAbsoluteURLInFull) sets whether absolute urls are displayed in full
void	setDisplayActual(boolean displayActual) sets whether the cell should display the actual value after evaluation.
void	setMinLengthForToggleCollapse(int minLen) renders the cell as a toggle area if the content of the cell is over the min value set here.
void	wrong(CellWrapper<E> expected, RestDataTypeAdapter typeAdapter) formats a cell representing a wrong expectation.

Method Detail

exception

void exception(CellWrapper<E> cellWrapper,
               Throwable exception)

formats a cell containing an exception.

Parameters:

cellWrapper - the cell wrapper

exception - the excteption to render.

exception

void exception(CellWrapper<E> cellWrapper,
               String exceptionMessage)

formats a cell containing an exception.

Parameters:

cellWrapper - the cell wrapper

exceptionMessage - the exception message to render.

check

void check(CellWrapper<E> valueCell,
           RestDataTypeAdapter adapter)

formats a check cell.

Parameters:

valueCell - the cell value.

adapter - the adapter interpreting the value.

label

String label(String string)

formats a cell label

Parameters:

string - the label

Returns:

the cell content as a label.

wrong

void wrong(CellWrapper<E> expected,
           RestDataTypeAdapter typeAdapter)

formats a cell representing a wrong expectation.

Parameters:

expected - the expected value

typeAdapter - the adapter with the actual value.

right

void right(CellWrapper<E> expected,
           RestDataTypeAdapter typeAdapter)

formats a cell representing a right expectation.

Parameters:

expected - the expected value

typeAdapter - the adapter with the actual value.

gray

String gray(String string)

formats a cell with a gray background. used to ignore the content or for comments.

Parameters:

string - the content

Returns:

the content grayed out.

asLink

void asLink(CellWrapper<E> cell,
            String resolvedUrl,
            String link,
            String text)

formats the content as a hyperlink.

Parameters:

cell - the cell.

resolvedUrl - the cell content after symbols' substitution.

link - the uri in the href.

text - the text.

setDisplayActual

void setDisplayActual(boolean displayActual)

sets whether the cell should display the actual value after evaluation.

Parameters:

displayActual - true if actual value has to be rendered.

setDisplayAbsoluteURLInFull

void setDisplayAbsoluteURLInFull(boolean displayAbsoluteURLInFull)

sets whether absolute urls are displayed in full

Parameters:

displayAbsoluteURLInFull - the value to set

setMinLengthForToggleCollapse

void setMinLengthForToggleCollapse(int minLen)

renders the cell as a toggle area if the content of the cell is over the min value set here.

Parameters:

minLen - the min value of the content of a cell.

isDisplayActual

boolean isDisplayActual()

Returns:

true if actual values are rendered.

fromRaw

String fromRaw(String text)

in SLIM cell content is HTML escaped - we abstract this method to delegate to formatter the cleaning of the content.

Parameters:

text - the text

Returns:

the cleaned text