com.clearlydecoded.commander.documentation

Class RestCommandHandlerDocumentationGenerator

java.lang.Object

com.clearlydecoded.commander.documentation.RestCommandHandlerDocumentationGenerator

public class RestCommandHandlerDocumentationGenerator
extends Object

RestCommandHandlerDocumentationGenerator is a utility class that produces JSON-based documentation for CommandHandlers.

Author:

Yaakov Chaikin (yaakov@ClearlyDecoded.com)

Constructor Summary

Constructors

Constructor and Description
RestCommandHandlerDocumentationGenerator()

Method Summary

Modifier and Type	Method and Description
static RestCommandHandlerDocumentation	generateDocumentation(CommandHandler commandHandler) Generates REST friendly documentation for the provided commandHandler.

Methods inherited from class java.lang.Object

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

Constructor Detail

RestCommandHandlerDocumentationGenerator

public RestCommandHandlerDocumentationGenerator()

Method Detail

generateDocumentation

public static RestCommandHandlerDocumentation generateDocumentation(CommandHandler commandHandler)
                                                             throws Exception

Generates REST friendly documentation for the provided commandHandler.

Parameters:

commandHandler - CommandHandler to generate documentation for.

Returns:

Object that hold the documentation for the provided commandHandler.

Throws:

Exception - If anything goes wrong with generating command handler documentation.