org.springframework.restdocs.snippet

Class DocumentationWriter

java.lang.Object

java.io.Writer

java.io.PrintWriter

org.springframework.restdocs.snippet.DocumentationWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

Direct Known Subclasses:

AsciidoctorWriter

public abstract class DocumentationWriter
extends PrintWriter

A PrintWriter that provides additional methods which are useful for producing API documentation.

Author:

Andy Wilkinson

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DocumentationWriter.DocumentationAction Encapsulates an action that outputs some documentation.
static interface	DocumentationWriter.TableAction Encapsulates an action that outputs a table.
static interface	DocumentationWriter.TableWriter A writer for producing a table

Field Summary

Fields inherited from class java.io.PrintWriter

out

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DocumentationWriter(Writer writer)

Method Summary

Modifier and Type	Method and Description
abstract void	codeBlock(String language, DocumentationWriter.DocumentationAction action) Calls the given action to document a code block.
abstract void	shellCommand(DocumentationWriter.DocumentationAction action) Calls the given action to document a shell command.
abstract void	table(DocumentationWriter.TableAction action) Calls the given action to document a table.

Methods inherited from class java.io.PrintWriter

append, append, append, checkError, clearError, close, flush, format, format, print, print, print, print, print, print, print, print, print, printf, printf, println, println, println, println, println, println, println, println, println, println, setError, write, write, write, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentationWriter

protected DocumentationWriter(Writer writer)

Method Detail

shellCommand

public abstract void shellCommand(DocumentationWriter.DocumentationAction action)
                           throws IOException

Calls the given action to document a shell command. Any prefix necessary for the documentation format is written prior to calling the action. Having called the action, any necessary suffix is then written.

Parameters:

action - the action that will produce the shell command

Throws:

IOException - if the documentation fails

codeBlock

public abstract void codeBlock(String language,
                               DocumentationWriter.DocumentationAction action)
                        throws IOException

Calls the given action to document a code block. The code block will be annotated as containing code written in the given language. Any prefix necessary for the documentation format is written prior to calling the action. Having called the action, any necessary suffix is then written.

Parameters:

language - the language in which the code is written

action - the action that will produce the code

Throws:

IOException - if the documentation fails

table

public abstract void table(DocumentationWriter.TableAction action)
                    throws IOException

Calls the given action to document a table. Any prefix necessary for documenting a table is written prior to calling the action. Having called the action, any necessary suffix is then written.

Parameters:

action - the action that will produce the table

Throws:

IOException - if the documentation fails