org.jomc.ant
Class SourceFileProcessorTask

Package class diagram package SourceFileProcessorTask
java.lang.Object
  extended by org.apache.tools.ant.ProjectComponent
      extended by org.apache.tools.ant.Task
          extended by org.jomc.ant.JomcTask
              extended by org.jomc.ant.JomcModelTask
                  extended by org.jomc.ant.JomcToolTask
                      extended by org.jomc.ant.SourceFileProcessorTask
All Implemented Interfaces:
Cloneable
Direct Known Subclasses:
ManageSourcesTask

public class SourceFileProcessorTask
extends JomcToolTask

Base class for executing source file processor based tasks.

Version:
$JOMC: SourceFileProcessorTask.java 3838 2011-10-08 20:15:41Z schulte2005 $
Author:
Christian Schulte
See Also:
processSourceFiles()

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
SourceFileProcessorTask()
          Creates a new SourceFileProcessorTask instance.
 
Method Summary
 SourceFileProcessorTask clone()
          Creates and returns a copy of this object.
 void configureSourceFileProcessor(SourceFileProcessor sourceFileProcessor)
          Configures a given SourceFileProcessor instance using the properties of the instance.
 void executeTask()
          Calls the processSourceFiles method if source processing is enabled.
 Class<? extends SourceFileProcessor> getSourceFileProcessorClass()
          Gets the class of the SourceFileProcessor backing the task.
 boolean isSourceProcessingEnabled()
          Gets a flag indicating the processing of source files is enabled.
 SourceFileProcessor newSourceFileProcessor()
          Creates a new SourceFileProcessor instance setup using the properties of the instance.
 void processSourceFiles()
          Processes source files.
 void setSourceFileProcessorClass(Class<? extends SourceFileProcessor> value)
          Sets the class of the SourceFileProcessor backing the task.
 void setSourceProcessingEnabled(boolean value)
          Sets the flag indicating the processing of source files is enabled.
 
Methods inherited from class org.jomc.ant.JomcToolTask
configureJomcTool, createLocale, createTemplateParameter, createTemplateParameterResource, createVelocityProperty, createVelocityPropertyResource, getDefaultTemplateProfile, getImplementation, getImplementation, getIndentation, getInputEncoding, getLineSeparator, getLocale, getModule, getModule, getOutputEncoding, getSpecification, getSpecification, getTemplateEncoding, getTemplateLocation, getTemplateParameterResources, getTemplateParameters, getTemplateProfile, getVelocityProperties, getVelocityPropertyResources, isModulesProcessingRequested, postExecuteTask, preExecuteTask, setDefaultTemplateProfile, setImplementation, setIndentation, setInputEncoding, setLineSeparator, setModule, setOutputEncoding, setSpecification, setTemplateEncoding, setTemplateLocation, setTemplateProfile
 
Methods inherited from class org.jomc.ant.JomcModelTask
createModuleResource, getModel, getModuleLocation, getModuleResources, getTransformerLocation, isModelObjectClasspathResolutionEnabled, isModelResourceValidationEnabled, newModelContext, 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

SourceFileProcessorTask

public SourceFileProcessorTask()
Creates a new SourceFileProcessorTask instance.

Method Detail

isSourceProcessingEnabled

public final boolean isSourceProcessingEnabled()
Gets a flag indicating the processing of source files is enabled.

Returns:
true, if processing of source files is enabled; false, else.
See Also:
setSourceProcessingEnabled(boolean)

setSourceProcessingEnabled

public final void setSourceProcessingEnabled(boolean value)
Sets the flag indicating the processing of source files is enabled.

Parameters:
value - true, to enable processing of source files; false, to disable processing of source files.
See Also:
isSourceProcessingEnabled()

getSourceFileProcessorClass

public final Class<? extends SourceFileProcessor> getSourceFileProcessorClass()
Gets the class of the SourceFileProcessor backing the task.

Returns:
The class of the SourceFileProcessor backing the task.
See Also:
setSourceFileProcessorClass(java.lang.Class)

setSourceFileProcessorClass

public final void setSourceFileProcessorClass(Class<? extends SourceFileProcessor> value)
Sets the class of the SourceFileProcessor backing the task.

Parameters:
value - The new class of the SourceFileProcessor backing the task or null.
See Also:
getSourceFileProcessorClass()

newSourceFileProcessor

public SourceFileProcessor newSourceFileProcessor()
                                           throws org.apache.tools.ant.BuildException
Creates a new SourceFileProcessor instance setup using the properties of the instance.

Returns:
A new SourceFileProcessor instance.
Throws:
org.apache.tools.ant.BuildException - if creating a new SourceFileProcessor instance fails.
See Also:
getSourceFileProcessorClass(), configureSourceFileProcessor(org.jomc.tools.SourceFileProcessor)

configureSourceFileProcessor

public void configureSourceFileProcessor(SourceFileProcessor sourceFileProcessor)
                                  throws org.apache.tools.ant.BuildException
Configures a given SourceFileProcessor instance using the properties of the instance.

Parameters:
sourceFileProcessor - The source file processor to configure.
Throws:
NullPointerException - if sourceFileProcessor is null.
org.apache.tools.ant.BuildException - if configuring sourceFileProcessor fails.
See Also:
JomcToolTask.configureJomcTool(org.jomc.tools.JomcTool)

executeTask

public final void executeTask()
                       throws org.apache.tools.ant.BuildException
Calls the processSourceFiles method if source processing is enabled.

Overrides:
executeTask in class JomcTask
Throws:
org.apache.tools.ant.BuildException - if processing source files fails.
See Also:
processSourceFiles()

processSourceFiles

public void processSourceFiles()
                        throws org.apache.tools.ant.BuildException
Processes source files.

Throws:
org.apache.tools.ant.BuildException - if processing source files fails.
See Also:
executeTask()

clone

public SourceFileProcessorTask clone()
Creates and returns a copy of this object.

Overrides:
clone in class JomcToolTask
Returns:
A copy of this object.


Copyright © 2005-2012 The JOMC Project. All Rights Reserved.Get JOMC at SourceForge.net. Fast, secure and Free Open Source software downloads
Please note that this documentation is maintained by non-native english speaking authors. As such, you may encounter phrases or wordings which seem imprecise or may even have a totally different meaning to native english speaking readers than what the individual author was trying to express. If you are a native english speaking reader and find any such phrases or wordings we kindly ask you to send an email to the corresponding author and help us improve this documentation in order to avoid misunderstandings. You will find the authors' email addresses at the top of each class. Please accept our apologies for any inconvenience caused.