org.jomc.ant

Class ClassFileProcessorTask

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

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 4613 2012-09-22 10:07:08Z schulte $

Author:

Christian Schulte

See Also:

processClassFiles()

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
ClassFileProcessorTask() Creates a new ClassFileProcessorTask instance.

Method Summary

Methods

Modifier and Type	Method and Description
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, getDefaultTemplateEncoding, getDefaultTemplateProfile, getImplementation, getImplementation, getIndentation, getInputEncoding, getLineSeparator, getLocale, getModule, getModule, getOutputEncoding, getSpecification, getSpecification, getTemplateEncoding, getTemplateLocation, getTemplateParameterResources, getTemplateParameters, getTemplateProfile, getVelocityProperties, getVelocityPropertyResources, isModulesProcessingRequested, postExecuteTask, preExecuteTask, 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

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.