com.clearlydecoded.messenger.documentation

Class RestProcessorDocumentationGenerator

java.lang.Object

com.clearlydecoded.messenger.documentation.RestProcessorDocumentationGenerator

public class RestProcessorDocumentationGenerator
extends Object

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

Author:

Yaakov Chaikin (yaakov@ClearlyDecoded.com)

Constructor Summary

Constructors

Constructor and Description
RestProcessorDocumentationGenerator()

Method Summary

Modifier and Type	Method and Description
static RestProcessorDocumentation	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

RestProcessorDocumentationGenerator

public RestProcessorDocumentationGenerator()

Method Detail

generateDocumentation

public static RestProcessorDocumentation 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.