de.sfuhrm.sudoku.output

Class MarkdownTableFormatter

java.lang.Object

de.sfuhrm.sudoku.output.MarkdownTableFormatter

All Implemented Interfaces:

GameMatrixFormatter

public class MarkdownTableFormatter
extends Object

Formats the game matrix to a markdown table.

Author:

Stephan Fuhrmann

Constructor Summary

Constructors

Constructor and Description
MarkdownTableFormatter()

Method Summary

Modifier and Type	Method and Description
String	documentEnd() Formats the document end part.
String	documentStart() Formats the document start part.
String	format(GameMatrix matrix) Formats the input game matrix to a text representation.
String	getLineSeparator() Gets the line separator String to use.
String	getUnknownCellContentCharacter() Gets the String to use for unknown/unset cells.
void	setLineSeparator(String lineSeparator) Sets the line separator String to use.
void	setUnknownCellContentCharacter(String unknownCellContentCharacter) Sets the String to use for unknown/unset cells.

Methods inherited from class java.lang.Object

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

Constructor Detail

MarkdownTableFormatter

public MarkdownTableFormatter()

Method Detail

format

public String format(GameMatrix matrix)

Description copied from interface: GameMatrixFormatter

Formats the input game matrix to a text representation.

Parameters:

matrix - the matrix to format to String format.

Returns:

a String representation of the game matrix.

getUnknownCellContentCharacter

public final String getUnknownCellContentCharacter()

Gets the String to use for unknown/unset cells.

setUnknownCellContentCharacter

public final void setUnknownCellContentCharacter(String unknownCellContentCharacter)

Sets the String to use for unknown/unset cells.

getLineSeparator

public final String getLineSeparator()

Gets the line separator String to use.

setLineSeparator

public final void setLineSeparator(String lineSeparator)

Sets the line separator String to use.

documentStart

public String documentStart()

Description copied from interface: GameMatrixFormatter

Formats the document start part.

Specified by:

documentStart in interface GameMatrixFormatter

documentEnd

public String documentEnd()

Description copied from interface: GameMatrixFormatter

Formats the document end part.

Specified by:

documentEnd in interface GameMatrixFormatter