org.springframework.restdocs.snippet

Class AsciidoctorWriter

java.lang.Object

java.io.Writer

java.io.PrintWriter

org.springframework.restdocs.snippet.DocumentationWriter

org.springframework.restdocs.snippet.AsciidoctorWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class AsciidoctorWriter
extends DocumentationWriter

A DocumentationWriter that produces output in Asciidoctor.

Author:

Andy Wilkinson

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.restdocs.snippet.DocumentationWriter

DocumentationWriter.DocumentationAction, DocumentationWriter.TableAction, DocumentationWriter.TableWriter

Field Summary

Fields inherited from class java.io.PrintWriter

out

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
AsciidoctorWriter(Writer writer) Creates a new AsciidoctorWriter that will write to the given writer

Method Summary

Modifier and Type	Method and Description
void	codeBlock(String language, DocumentationWriter.DocumentationAction action) Calls the given action to document a code block.
void	shellCommand(DocumentationWriter.DocumentationAction action) Calls the given action to document a shell command.
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

AsciidoctorWriter

public AsciidoctorWriter(Writer writer)

Creates a new AsciidoctorWriter that will write to the given writer

Parameters:

writer - The writer to which output will be written

Method Detail

shellCommand

public void shellCommand(DocumentationWriter.DocumentationAction action)
                  throws IOException

Description copied from class: DocumentationWriter

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.

Specified by:

shellCommand in class DocumentationWriter

Parameters:

action - the action that will produce the shell command

Throws:

IOException - if the documentation fails

codeBlock

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

Description copied from class: DocumentationWriter

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.

Specified by:

codeBlock in class DocumentationWriter

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 void table(DocumentationWriter.TableAction action)
           throws IOException

Description copied from class: DocumentationWriter

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.

Specified by:

table in class DocumentationWriter

Parameters:

action - the action that will produce the table

Throws:

IOException - if the documentation fails