org.codehaus.cargo.documentation
Class ConfluenceContainerDocumentationGenerator

java.lang.Object
  extended by org.codehaus.cargo.documentation.ConfluenceContainerDocumentationGenerator

public class ConfluenceContainerDocumentationGenerator
extends Object

Generate container documentation using Confluence markup language. The generated text is meant to be copied on the Cargo Confluence web site.

Version:
$Id: ConfluenceContainerDocumentationGenerator.java 1927 2009-03-13 00:17:50Z rynam0 $

Constructor Summary
ConfluenceContainerDocumentationGenerator()
           
 
Method Summary
protected  String computedFQCN(String className)
           
protected  String findPropertySetFieldName(String propertyValue)
           
protected  String findPropertySetFieldName(String propertyValue, Class propertySetClass)
           
protected  StringBuffer generateConfigurationFeaturesText(String containerId)
           
protected  StringBuffer generateConfigurationPropertiesForConfigurationTypeForContainerType(String typeAsName, ConfigurationType type, String containerId, ContainerType containerType)
           
protected  StringBuffer generateConfigurationPropertiesText(String containerId)
           
protected  StringBuffer generateContainerFeaturesText(String containerId)
           
protected  StringBuffer generateDeployerFeaturesText(String containerId)
           
 String generateDocumentation(String containerId)
           
protected  StringBuffer generateExistingConfigurationText(String containerId, ContainerType type)
           
protected  StringBuffer generateOtherFeaturesText(String containerId)
           
protected  StringBuffer generateStandaloneConfigurationText(String containerId, ContainerType type)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ConfluenceContainerDocumentationGenerator

public ConfluenceContainerDocumentationGenerator()
Method Detail

generateDocumentation

public String generateDocumentation(String containerId)
                             throws Exception
Throws:
Exception

generateContainerFeaturesText

protected StringBuffer generateContainerFeaturesText(String containerId)

generateStandaloneConfigurationText

protected StringBuffer generateStandaloneConfigurationText(String containerId,
                                                           ContainerType type)

generateExistingConfigurationText

protected StringBuffer generateExistingConfigurationText(String containerId,
                                                         ContainerType type)

generateConfigurationFeaturesText

protected StringBuffer generateConfigurationFeaturesText(String containerId)

generateDeployerFeaturesText

protected StringBuffer generateDeployerFeaturesText(String containerId)

generateOtherFeaturesText

protected StringBuffer generateOtherFeaturesText(String containerId)

generateConfigurationPropertiesText

protected StringBuffer generateConfigurationPropertiesText(String containerId)
                                                    throws Exception
Throws:
Exception

generateConfigurationPropertiesForConfigurationTypeForContainerType

protected StringBuffer generateConfigurationPropertiesForConfigurationTypeForContainerType(String typeAsName,
                                                                                           ConfigurationType type,
                                                                                           String containerId,
                                                                                           ContainerType containerType)
                                                                                    throws Exception
Throws:
Exception

computedFQCN

protected String computedFQCN(String className)

findPropertySetFieldName

protected String findPropertySetFieldName(String propertyValue)
                                   throws Exception
Throws:
Exception

findPropertySetFieldName

protected String findPropertySetFieldName(String propertyValue,
                                          Class propertySetClass)
                                   throws Exception
Throws:
Exception


Copyright © 2004-2012 Codehaus. All Rights Reserved.