io.github.robwin.swagger2markup.builder.document

Class MarkupDocument

java.lang.Object

io.github.robwin.swagger2markup.builder.document.MarkupDocument

Direct Known Subclasses:

DefinitionsDocument, OverviewDocument, PathsDocument

public abstract class MarkupDocument
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	CONSUMES
protected java.lang.String	DEFAULT_COLUMN
protected static java.lang.String	DELIMITER
protected java.lang.String	DESCRIPTION
protected java.lang.String	DESCRIPTION_COLUMN
protected org.slf4j.Logger	logger
protected io.github.robwin.markup.builder.MarkupDocBuilder	markupDocBuilder
protected io.github.robwin.markup.builder.MarkupLanguage	markupLanguage
protected java.lang.String	NAME_COLUMN
protected java.lang.String	PRODUCES
protected java.lang.String	REQUIRED_COLUMN
protected java.lang.String	SCHEMA_COLUMN
protected io.swagger.models.Swagger	swagger
protected java.lang.String	TAGS

Method Summary

Methods

Modifier and Type	Method and Description
abstract MarkupDocument	build() Builds the MarkupDocument.
java.lang.String	toString() Returns a string representation of the document.
void	writeToFile(java.lang.String directory, java.lang.String fileName, java.nio.charset.Charset charset) Writes the content of the builder to a file and clears the builder.

Methods inherited from class java.lang.Object

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

Field Detail

DELIMITER

protected static final java.lang.String DELIMITER

See Also:

Constant Field Values

DEFAULT_COLUMN

protected final java.lang.String DEFAULT_COLUMN

REQUIRED_COLUMN

protected final java.lang.String REQUIRED_COLUMN

SCHEMA_COLUMN

protected final java.lang.String SCHEMA_COLUMN

NAME_COLUMN

protected final java.lang.String NAME_COLUMN

DESCRIPTION_COLUMN

protected final java.lang.String DESCRIPTION_COLUMN

DESCRIPTION

protected final java.lang.String DESCRIPTION

PRODUCES

protected final java.lang.String PRODUCES

CONSUMES

protected final java.lang.String CONSUMES

TAGS

protected final java.lang.String TAGS

logger

protected org.slf4j.Logger logger

swagger

protected io.swagger.models.Swagger swagger

markupLanguage

protected io.github.robwin.markup.builder.MarkupLanguage markupLanguage

markupDocBuilder

protected io.github.robwin.markup.builder.MarkupDocBuilder markupDocBuilder

Method Detail

build

public abstract MarkupDocument build()
                              throws java.io.IOException

Builds the MarkupDocument.

Returns:

the built MarkupDocument

Throws:

java.io.IOException - if the files to include are not readable

toString

public java.lang.String toString()

Returns a string representation of the document.

Overrides:

toString in class java.lang.Object

writeToFile

public void writeToFile(java.lang.String directory,
               java.lang.String fileName,
               java.nio.charset.Charset charset)
                 throws java.io.IOException

Writes the content of the builder to a file and clears the builder.

Parameters:

directory - the directory where the generated file should be stored

fileName - the name of the file

charset - the the charset to use for encoding

Throws:

java.io.IOException - if the file cannot be written