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

Class AbstractDocMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

GenerateAPTDocMojo, GenerateXMLDocMojo

public abstract class AbstractDocMojo
extends AbstractBWMojo

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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.io.File	docDirectory Path to the output folder.

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
AbstractDocMojo()

Method Summary

Modifier and Type	Method and Description
void	applyXSL(java.io.File in, java.io.File out, java.io.InputStream inputStream)
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.lang.String	getDescription(java.io.File f)
protected java.io.File	getDirectoryToProcess()
java.util.List<java.io.File>	getFiles()
protected java.util.List<java.io.File>	initFiles()
abstract void	processFile(java.io.File f)

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

Field Detail

docDirectory

@Parameter(property="project.doc.directory",
           required=true,
           defaultValue="target/doc")
protected java.io.File docDirectory

Path to the output folder. Default is "target/doc"

Constructor Detail

AbstractDocMojo

public AbstractDocMojo()

Method Detail

processFile

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

Throws:

org.apache.maven.plugin.MojoExecutionException

getDescription

protected java.lang.String getDescription(java.io.File f)
                                   throws javax.xml.bind.JAXBException

Throws:

javax.xml.bind.JAXBException

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 AbstractBWMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

getFiles

public java.util.List<java.io.File> getFiles()

getDirectoryToProcess

protected java.io.File getDirectoryToProcess()

initFiles

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

Throws:

java.io.IOException

applyXSL

public void applyXSL(java.io.File in,
                     java.io.File out,
                     java.io.InputStream inputStream)
              throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException