com.clearlydecoded.messenger.documentation

Class RestMessageProcessorDocumentationGenerator

java.lang.Object

com.clearlydecoded.messenger.documentation.RestMessageProcessorDocumentationGenerator

public class RestMessageProcessorDocumentationGenerator
extends Object

RestMessageProcessorDocumentationGenerator is a utility class that produces JSON-based documentation for MessageProcessors.

Author:

Yaakov Chaikin (yaakov@ClearlyDecoded.com)

Constructor Summary

Constructors

Constructor and Description
RestMessageProcessorDocumentationGenerator()

Method Summary

Modifier and Type	Method and Description
static RestMessageProcessorDocumentation	generateDocumentation(MessageProcessor processor) Generates REST friendly documentation for the provided processor.

Methods inherited from class java.lang.Object

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

Constructor Detail

RestMessageProcessorDocumentationGenerator

public RestMessageProcessorDocumentationGenerator()

Method Detail

generateDocumentation

public static RestMessageProcessorDocumentation generateDocumentation(MessageProcessor processor)
                                                               throws Exception

Generates REST friendly documentation for the provided processor.

Parameters:

processor - MessageProcessor to generate documentation for.

Returns:

Object that hold the documentation for the provided processor.

Throws:

Exception - If anything goes wrong with generating message processor documentation.