io.warp10.warpfleet.doc.generators

Class AbstractGenerator

java.lang.Object

io.warp10.warpfleet.doc.generators.AbstractGenerator

Direct Known Subclasses:

JSONGenerator, MarkdownGenerator

public abstract class AbstractGenerator
extends java.lang.Object

The type Abstract generator.

Method Summary

Modifier and Type	Method and Description
protected kong.unirest.json.JSONObject	generateSignature(kong.unirest.json.JSONObject doc) Generate signature json object.
abstract java.util.List<kong.unirest.json.JSONObject>	output(java.io.File dest, java.util.List<kong.unirest.json.JSONObject> doc) Output list.
static java.lang.String	sanitize(java.lang.String str) Sanitize string.

Methods inherited from class java.lang.Object

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

Method Detail

sanitize

public static java.lang.String sanitize(java.lang.String str)

Sanitize string.

Parameters:

str - the str

Returns:

the string

output

public abstract java.util.List<kong.unirest.json.JSONObject> output(java.io.File dest,
                                                                    java.util.List<kong.unirest.json.JSONObject> doc)
                                                             throws java.io.IOException

Output list.

Parameters:

dest - the dest

doc - the doc

Returns:

the list

Throws:

java.io.IOException - the io exception

generateSignature

protected kong.unirest.json.JSONObject generateSignature(kong.unirest.json.JSONObject doc)

Generate signature json object.

Parameters:

doc - the doc

Returns:

the json object