fr.fastconnect.factory.tibco.bw.maven.doc

Class GenerateAPTDocMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

fr.fastconnect.factory.tibco.bw.maven.AbstractBWMojo

fr.fastconnect.factory.tibco.bw.maven.doc.AbstractDocMojo

fr.fastconnect.factory.tibco.bw.maven.doc.GenerateAPTDocMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="generate-doc-apt",
      defaultPhase=PROCESS_SOURCES)
 @Execute(goal="generate-doc-apt",
         phase=PROCESS_SOURCES)
public class GenerateAPTDocMojo
extends AbstractDocMojo

This goal generates an APT documentation file from TIBCO BusinessWorks source files.

The "generate-doc-xml" goal is used to generate XML files.

Field Summary

Fields inherited from class fr.fastconnect.factory.tibco.bw.maven.doc.AbstractDocMojo

docDirectory

Fields inherited from class fr.fastconnect.factory.tibco.bw.maven.AbstractBWMojo

ALIASES_FILE, APPMANAGE_BINARY_NOTFOUND, buildLibDirectory, buildSrcDirectory, BWEAR_DEPLOY_TYPE, BWEAR_EXTENSION, BWEAR_TYPE, BWPROJECT_NOTFOUND, BWPROJECT_PREF_LIB_ERROR_MSG, dependenciesIgnored, DESIGNER_BINARY_NOTFOUND, DESIGNER5_PREFS, directory, DTL_FILE_NAME, FILE_ALIAS_PREFIX, FILE_ALIAS_PREFIX_ESCAPED, HAWK_BINARY_NOTFOUND, hawkDomain, hawkRvDaemon, hawkRvNetwork, hawkRvService, hawkSubscribeInterval, hawkSubscribeNumberOfRetry, hawkVersion, hideLibraryResources, JAR_EXTENSION, JAR_TYPE, mavenPropertyPattern, outputDirectory, packageDirectory, POM_EXTENSION, POM_TYPE, projectDirectory, PROJLIB_EXTENSION, PROJLIB_TYPE, PROPERTIES_EXTENSION, session, SKIPPING, sourceEncoding, testDirectory, testLibDirectory, testSrcDirectory, TIBCO_ALIAS_PREFIX, TIBCO_HOME_DIR, tibcoAppManagePath, tibcoAppManageTRAPath, tibcoBuildEARTRAPath, tibcoBuildEARUseDesignerTRA, tibcoBuildLibraryTRAPath, tibcoBuildLibraryUseDesignerTRA, tibcoBWEngineTRAPath, tibcoDesignerPath, tibcoDesignerTRAPath, tibcoHome, tibcoRvHomePath, timeOut, XML_EXTENSION, XML_TYPE

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
GenerateAPTDocMojo()

Method Summary

Modifier and Type	Method and Description
void	execute() The execute method of this Mojo will : check that the BusinessWorks project exists copy the Designer5.prefs file copy the .designtimelibs file useful for setting a TIBCO environment for the project being built.
protected java.io.File	getDirectoryToProcess()
protected java.util.List<java.io.File>	initFiles()
void	processFile(java.io.File f)

Methods inherited from class fr.fastconnect.factory.tibco.bw.maven.doc.AbstractDocMojo

applyXSL, getDescription, getFiles

Methods inherited from class fr.fastconnect.factory.tibco.bw.maven.AbstractBWMojo

checkAppManage, checkDesigner, enableTestScope, getAliasesFile, getBWEARAlias, getBWEARName, getBWEARsDependencies, getDependencies, getDependencyPath, getDesigner5Prefs, getJarAlias, getJarDependencies, getJarName, getProject, getProjlibAlias, getProjlibName, getProjlibsDependencies, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValueInSettings, getRootProjectProperty, getRootProjectProperty, getSession, initHawk, isCurrentGoal, launchTIBCOBinary, launchTIBCOBinary, propertiesManager, propertyExists, propertyExists, propertyExistsInSettings, propertyExistsInSettings, readDependenciesFromFile, replaceProperties, setProject, setSession, setSettings

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Constructor Detail

GenerateAPTDocMojo

public GenerateAPTDocMojo()

Method Detail

processFile

public void processFile(java.io.File f)
                 throws org.apache.maven.plugin.MojoExecutionException

Specified by:

processFile in class AbstractDocMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Description copied from class: AbstractBWMojo

The execute method of this Mojo will :

• check that the BusinessWorks project exists
• copy the Designer5.prefs file
• copy the .designtimelibs file useful for setting a TIBCO environment for the project being built.

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Overrides:

execute in class AbstractDocMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

getDirectoryToProcess

protected java.io.File getDirectoryToProcess()

Overrides:

getDirectoryToProcess in class AbstractDocMojo

initFiles

protected java.util.List<java.io.File> initFiles()
                                          throws java.io.IOException

Overrides:

initFiles in class AbstractDocMojo

Throws:

java.io.IOException