org.codehaus.cargo.documentation

Class ConfluenceContainerDocumentationGenerator

java.lang.Object

org.codehaus.cargo.documentation.ConfluenceContainerDocumentationGenerator

public class ConfluenceContainerDocumentationGenerator
extends java.lang.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 3900 2014-11-04 06:52:00Z alitokmen $

Constructor Summary

Constructors

Constructor and Description
ConfluenceContainerDocumentationGenerator()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	computedFQCN(java.lang.String className) Create the short class name for a given class name.
protected java.lang.reflect.Field	findPropertySetField(java.lang.String propertyValue, java.lang.Class propertySetClass) Find the property set field name for a given value on a given class.
protected java.lang.reflect.Field	findPropertySetFieldName(java.lang.String propertyValue) Find the property set field for a given value.
protected java.lang.String	generateConfigurationFeaturesText(java.lang.String containerId) Generate documentation for the configuration features of a given container.
protected java.lang.String	generateConfigurationPropertiesForConfigurationTypeForContainerType(java.lang.String typeAsName, ConfigurationType type, java.lang.String containerId, ContainerType containerType) Generate documentation for the configuration properties of a given container.
protected java.lang.String	generateConfigurationPropertiesText(java.lang.String containerId) Generate documentation for the configuration properties of a given container.
protected java.lang.String	generateContainerFeaturesText(java.lang.String containerId) Generate documentation for the container features of a given container.
java.lang.String	generateDatasourceDocumentation() Generate documentation for a datasources.
protected java.lang.String	generateDeployerFeaturesText(java.lang.String containerId) Generate documentation for the deployer features of a given container.
java.lang.String	generateDocumentation(java.lang.String containerId) Generate documentation for a given container.
protected java.lang.String	generateExistingConfigurationText(java.lang.String containerId, ContainerType type) Generate documentation for the existing configuration of a given container.
protected java.lang.String	generateOtherFeaturesText(java.lang.String containerId) Generate documentation for other features of a given container.
protected java.lang.String	generateSamplesInfoText(java.lang.String containerId) Generate documentation for the Samples of a given container.
protected java.lang.String	generateStandaloneConfigurationText(java.lang.String containerId, ContainerType type) Generate documentation for the standalone configuration of a given container.
java.lang.String	getContainerServerDownloadUrl(java.lang.String containerId) Returns the download URL used for testing the given container.

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

generateDatasourceDocumentation

public java.lang.String generateDatasourceDocumentation()
                                                 throws java.lang.Exception

Generate documentation for a datasources.

Returns:

Generated documentation.

Throws:

java.lang.Exception - If anything goes wrong.

generateDocumentation

public java.lang.String generateDocumentation(java.lang.String containerId)
                                       throws java.lang.Exception

Generate documentation for a given container.

Parameters:

containerId - Container id.

Returns:

Generated documentation.

Throws:

java.lang.Exception - If anything goes wrong.

generateContainerFeaturesText

protected java.lang.String generateContainerFeaturesText(java.lang.String containerId)

Generate documentation for the container features of a given container.

Parameters:

containerId - Container id.

Returns:

Generated container features documentation.

generateStandaloneConfigurationText

protected java.lang.String generateStandaloneConfigurationText(java.lang.String containerId,
                                                               ContainerType type)

Generate documentation for the standalone configuration of a given container.

Parameters:

containerId - Container id.

type - Container type.

Returns:

Generated standalone configuration documentation.

generateExistingConfigurationText

protected java.lang.String generateExistingConfigurationText(java.lang.String containerId,
                                                             ContainerType type)

Generate documentation for the existing configuration of a given container.

Parameters:

containerId - Container id.

type - Container type.

Returns:

Generated existing configuration documentation.

generateConfigurationFeaturesText

protected java.lang.String generateConfigurationFeaturesText(java.lang.String containerId)

Generate documentation for the configuration features of a given container.

Parameters:

containerId - Container id.

Returns:

Generated configuration features documentation.

generateDeployerFeaturesText

protected java.lang.String generateDeployerFeaturesText(java.lang.String containerId)

Generate documentation for the deployer features of a given container.

Parameters:

containerId - Container id.

Returns:

Generated deployer features documentation.

generateOtherFeaturesText

protected java.lang.String generateOtherFeaturesText(java.lang.String containerId)

Generate documentation for other features of a given container.

Parameters:

containerId - Container id.

Returns:

Generated other features' documentation.

generateConfigurationPropertiesText

protected java.lang.String generateConfigurationPropertiesText(java.lang.String containerId)
                                                        throws java.lang.Exception

Generate documentation for the configuration properties of a given container.

Parameters:

containerId - Container id.

Returns:

Generated configuration properties documentation.

Throws:

java.lang.Exception - If anything goes wrong.

generateConfigurationPropertiesForConfigurationTypeForContainerType

protected java.lang.String generateConfigurationPropertiesForConfigurationTypeForContainerType(java.lang.String typeAsName,
                                                                                               ConfigurationType type,
                                                                                               java.lang.String containerId,
                                                                                               ContainerType containerType)
                                                                                        throws java.lang.Exception

Generate documentation for the configuration properties of a given container.

Parameters:

typeAsName - Configuration type's "human" name.

type - Configuration type.

containerId - Container id.

containerType - Container type.

Returns:

Generated configuration properties documentation.

Throws:

java.lang.Exception - If anything goes wrong.

computedFQCN

protected java.lang.String computedFQCN(java.lang.String className)

Create the short class name for a given class name.

Parameters:

className - Original class name.

Returns:

Short class name.

findPropertySetFieldName

protected java.lang.reflect.Field findPropertySetFieldName(java.lang.String propertyValue)
                                                    throws java.lang.Exception

Find the property set field for a given value.

Parameters:

propertyValue - Property value name.

Returns:

Property set field for the given value.

Throws:

java.lang.Exception - If anything goes wrong.

findPropertySetField

protected java.lang.reflect.Field findPropertySetField(java.lang.String propertyValue,
                                                       java.lang.Class propertySetClass)
                                                throws java.lang.Exception

Find the property set field name for a given value on a given class.

Parameters:

propertyValue - Property value name.

propertySetClass - Class name.

Returns:

Property set field for the given value, null if the given class does not have such a value.

Throws:

java.lang.Exception - If anything goes wrong.

generateSamplesInfoText

protected java.lang.String generateSamplesInfoText(java.lang.String containerId)
                                            throws java.lang.Exception

Generate documentation for the Samples of a given container.

Parameters:

containerId - Container id.

Returns:

Generated configuration properties documentation.

Throws:

java.lang.Exception - If anything goes wrong.

getContainerServerDownloadUrl

public java.lang.String getContainerServerDownloadUrl(java.lang.String containerId)

Returns the download URL used for testing the given container.

Parameters:

containerId - Container ID.

Returns:

Download URL for testing containerId, null if no download URL is set.