org.jomc.ant

Class CommitClassesTask

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.jomc.ant.JomcTask

org.jomc.ant.JomcModelTask

org.jomc.ant.JomcToolTask

org.jomc.ant.ClassFileProcessorTask

org.jomc.ant.CommitClassesTask

All Implemented Interfaces:

Cloneable

public final class CommitClassesTask
extends ClassFileProcessorTask

Task for committing model objects to class files.

Version:

$JOMC: CommitClassesTask.java 4613 2012-09-22 10:07:08Z schulte $

Author:

Christian Schulte

Property Summary

Properties inherited from class org.jomc.ant.JomcToolTask

createVelocityProperty

Properties inherited from class org.jomc.ant.JomcTask

createTransformationOutputProperty

Field Summary

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

Constructors

Constructor and Description
CommitClassesTask() Creates a new CommitClassesTask instance.

Method Summary

Methods

Modifier and Type	Method and Description
CommitClassesTask	clone() Creates and returns a copy of this object.
TransformerResourceType	createModelObjectStylesheetResource() Creates a new modelObjectStylesheetResource element instance.
File	getClassesDirectory() Gets the directory holding the class files to commit model objects to.
List<TransformerResourceType>	getModelObjectStylesheetResources() Gets the XSLT documents to use for transforming model objects.
void	preExecuteTask() Called by the execute method prior to the executeTask method.
void	processClassFiles() Commits model objects to class files.
void	setClassesDirectory(File value) Sets the directory holding the class files to commit model objects to.

Methods inherited from class org.jomc.ant.ClassFileProcessorTask

configureClassFileProcessor, executeTask, getClassFileProcessorClass, isClassProcessingEnabled, newClassFileProcessor, setClassFileProcessorClass, setClassProcessingEnabled

Methods inherited from class org.jomc.ant.JomcToolTask

configureJomcTool, createLocale, createTemplateParameter, createTemplateParameterResource, createVelocityProperty, createVelocityPropertyResource, getDefaultTemplateEncoding, getDefaultTemplateProfile, getImplementation, getImplementation, getIndentation, getInputEncoding, getLineSeparator, getLocale, getModule, getModule, getOutputEncoding, getSpecification, getSpecification, getTemplateEncoding, getTemplateLocation, getTemplateParameterResources, getTemplateParameters, getTemplateProfile, getVelocityProperties, getVelocityPropertyResources, isModulesProcessingRequested, postExecuteTask, setDefaultTemplateEncoding, setDefaultTemplateProfile, setImplementation, setIndentation, setInputEncoding, setLineSeparator, setModule, setOutputEncoding, setSpecification, setTemplateEncoding, setTemplateLocation, setTemplateProfile

Methods inherited from class org.jomc.ant.JomcModelTask

createModuleResource, getModel, getModuleLocation, getModuleResources, getTransformerLocation, isJavaValidationEnabled, isModelObjectClasspathResolutionEnabled, isModelResourceValidationEnabled, newModelContext, setJavaValidationEnabled, setModelObjectClasspathResolutionEnabled, setModelResourceValidationEnabled, setModuleLocation, setTransformerLocation

Methods inherited from class org.jomc.ant.JomcTask

assertKeysNotNull, assertLocationsNotNull, assertNamesNotNull, assertNotNull, createClasspath, createModelContextAttribute, createTransformationOutputProperty, createTransformationParameter, createTransformationParameterResource, execute, getClasspath, getDirectory, getIf, getModel, getModelContextAttributes, getModelContextFactoryClassName, getModletLocation, getModletSchemaSystemId, getPlatformProviderLocation, getProperties, getProviderLocation, getResource, getResources, getTransformationOutputProperties, getTransformationParameterResources, getTransformationParameters, getTransformer, getUnless, isModelProcessingEnabled, isModletResourceValidationEnabled, logMessage, logMessage, logSeparator, logValidationReport, newProjectClassLoader, setClasspath, setClasspathRef, setIf, setModel, setModelContextFactoryClassName, setModelProcessingEnabled, setModletLocation, setModletResourceValidationEnabled, setModletSchemaSystemId, setPlatformProviderLocation, setProviderLocation, setUnless

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

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

Constructor Detail

CommitClassesTask

public CommitClassesTask()

Creates a new CommitClassesTask instance.

Method Detail

getClassesDirectory

public File getClassesDirectory()

Gets the directory holding the class files to commit model objects to.

Returns:

The directory holding the class files to commit model objects to or null.

See Also:

setClassesDirectory(java.io.File)

setClassesDirectory

public void setClassesDirectory(File value)

Sets the directory holding the class files to commit model objects to.

Parameters:

value - The new directory holding the class files to commit model objects to or null.

See Also:

getClassesDirectory()

getModelObjectStylesheetResources

public List<TransformerResourceType> getModelObjectStylesheetResources()

Gets the XSLT documents to use for transforming model objects.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the object. This is why there is no set method for the model object stylesheet resources property.

Returns:

The XSLT documents to use for transforming model objects.

See Also:

createModelObjectStylesheetResource()

createModelObjectStylesheetResource

public TransformerResourceType createModelObjectStylesheetResource()

Creates a new modelObjectStylesheetResource element instance.

Returns:

A new modelObjectStylesheetResource element instance.

See Also:

getModelObjectStylesheetResources()

preExecuteTask

public void preExecuteTask()
                    throws org.apache.tools.ant.BuildException

Called by the execute method prior to the executeTask method.

Overrides:

preExecuteTask in class JomcToolTask

Throws:

org.apache.tools.ant.BuildException - if execution fails.

See Also:

JomcTask.execute()

processClassFiles

public void processClassFiles()
                       throws org.apache.tools.ant.BuildException

Commits model objects to class files.

Overrides:

processClassFiles in class ClassFileProcessorTask

Throws:

org.apache.tools.ant.BuildException - if committing model objects fails.

See Also:

ClassFileProcessorTask.executeTask()

clone

public CommitClassesTask clone()

Creates and returns a copy of this object.

Overrides:

clone in class ClassFileProcessorTask

Returns:

A copy of this object.