Package com.github.joschi.jadconfig.documentation.printers

Class CsvDocsPrinter

java.lang.Object

com.github.joschi.jadconfig.documentation.printers.CsvDocsPrinter

All Implemented Interfaces:

DocsPrinter, Closeable, Flushable, AutoCloseable

public class CsvDocsPrinter
extends Object
implements DocsPrinter

Field Summary

Fields

Modifier and Type	Field	Description
static final String	HEADER_DEFAULT_VALUE
static final String	HEADER_DESCRIPTION
static final String	HEADER_PARAMETER
static final String	HEADER_REQUIRED
static final String	HEADER_TYPE
static final String[]	HEADERS

Constructor Summary

Constructors

Constructor	Description
CsvDocsPrinter(OutputStreamWriter streamWriter)

Method Summary

Modifier and Type	Method	Description
void	close()
void	flush()
void	write(List<ConfigurationSection> sections)

Methods inherited from class java.lang.Object

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

Field Details

HEADER_PARAMETER

public static final String HEADER_PARAMETER

See Also:

• Constant Field Values

HEADER_TYPE

public static final String HEADER_TYPE

See Also:

• Constant Field Values

HEADER_REQUIRED

public static final String HEADER_REQUIRED

See Also:

• Constant Field Values

HEADER_DEFAULT_VALUE

public static final String HEADER_DEFAULT_VALUE

See Also:

• Constant Field Values

HEADER_DESCRIPTION

public static final String HEADER_DESCRIPTION

See Also:

• Constant Field Values

HEADERS

public static final String[] HEADERS

Constructor Details

CsvDocsPrinter

public CsvDocsPrinter(OutputStreamWriter streamWriter)
               throws IOException

Throws:

IOException

Method Details

write

public void write(List<ConfigurationSection> sections)

Specified by:

write in interface DocsPrinter

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Throws:

IOException