org.jomc.ant
Class ClassFileProcessorTask

Package class diagram package ClassFileProcessorTask
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.ClassFileProcessorTask
All Implemented Interfaces:
Cloneable
Direct Known Subclasses:
CommitClassesTask, ValidateClassesTask, ValidateClasspathTask

public class ClassFileProcessorTask
extends JomcToolTask

Base class for executing class file processor based tasks.

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

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
ClassFileProcessorTask()
          Creates a new ClassFileProcessorTask instance.
 
Method Summary
 ClassFileProcessorTask clone()
          Creates and returns a copy of this object.
 void configureClassFileProcessor(ClassFileProcessor classFileProcessor)
          Configures a given ClassFileProcessor instance using the properties of the instance.
 void executeTask()
          Calls the processClassFiles method if class processing is enabled.
 Class<? extends ClassFileProcessor> getClassFileProcessorClass()
          Gets the class of the ClassFileProcessor backing the task.
 boolean isClassProcessingEnabled()
          Gets a flag indicating the processing of classes is enabled.
 ClassFileProcessor newClassFileProcessor()
          Creates a new ClassFileProcessor instance setup using the properties of the instance.
 void processClassFiles()
          Processes class files.
 void setClassFileProcessorClass(Class<? extends ClassFileProcessor> value)
          Sets the class of the ClassFileProcessor backing the task.
 void setClassProcessingEnabled(boolean value)
          Sets the flag indicating the processing of classes 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

ClassFileProcessorTask

public ClassFileProcessorTask()
Creates a new ClassFileProcessorTask instance.

Method Detail

isClassProcessingEnabled

public final boolean isClassProcessingEnabled()
Gets a flag indicating the processing of classes is enabled.

Returns:
true, if processing of classes is enabled; false, else.
See Also:
setClassProcessingEnabled(boolean)

setClassProcessingEnabled

public final void setClassProcessingEnabled(boolean value)
Sets the flag indicating the processing of classes is enabled.

Parameters:
value - true, to enable processing of classes; false, to disable processing of classes.
See Also:
isClassProcessingEnabled()

getClassFileProcessorClass

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

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

setClassFileProcessorClass

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

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

newClassFileProcessor

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

Returns:
A new ClassFileProcessor instance.
Throws:
org.apache.tools.ant.BuildException - if creating a new ClassFileProcessor instance fails.
See Also:
getClassFileProcessorClass(), configureClassFileProcessor(org.jomc.tools.ClassFileProcessor)

configureClassFileProcessor

public void configureClassFileProcessor(ClassFileProcessor classFileProcessor)
                                 throws org.apache.tools.ant.BuildException
Configures a given ClassFileProcessor instance using the properties of the instance.

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

executeTask

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

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

processClassFiles

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

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

clone

public ClassFileProcessorTask 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.