com.ibm.xtools.transform.team

Class ValidateEditTransformUtility

java.lang.Object

com.ibm.xtools.transform.core.AbstractTransformElement

com.ibm.xtools.transform.core.AbstractTransform

com.ibm.xtools.transform.core.TransformUtility

com.ibm.xtools.transform.team.ValidateEditTransformUtility

All Implemented Interfaces:

ITransformationItem

Direct Known Subclasses:

SaveDirtyFilesUtility

public class ValidateEditTransformUtility
extends TransformUtility

This Validate Edit Transform Utiltiy provides a mechanism for transformations to ensure that the files they want to modify will have the correct permissions. The transformation author should insert this utility into his transformation execution list at a point where it will only be executed once and before any of the affected files are modified. Before the rule is executed, the transformation must indicate the files (IFile) that will be modified by calling the addAffectedFiles() methods. These (static) methods can be called multiple times to add files to the set of affected files maintained by the rule. The list of files is stored in the context.

Field Summary

Fields inherited from class com.ibm.xtools.transform.core.AbstractTransform

CODE_OTHER, CODE_PROPERTY, CODE_SOURCE, CODE_TARGET, CODE_TARGET_CONTAINER

Constructor Summary

Constructors

Constructor and Description
ValidateEditTransformUtility(ITransformUtilityDescriptor descriptor) Constructor

Method Summary

Modifier and Type	Method and Description
static void	addAffectedFile(ITransformContext context, org.eclipse.core.resources.IFile file) Add a file to the list of affected files.
static void	addAffectedFiles(ITransformContext context, java.util.List fileList) Add the given files to the list of affected files.
boolean	canAccept(ITransformContext context) Using the context, determine if this transformation element should be executed.
void	doExecute(ITransformContext context) The specific task that this TransformUtility performs based on the data contained within the execution context.
protected static java.util.HashSet	getAffectedFiles(ITransformContext context) Get the list of affected files from the context.
protected void	reportError(org.eclipse.core.runtime.IStatus status, ITransformContext context) Process error that occured during file validation.

Methods inherited from class com.ibm.xtools.transform.core.TransformUtility

createContext, execute, getWorkUnitsPropertyId, handle, internalExecute, setPropertyInContext, validateContext

Methods inherited from class com.ibm.xtools.transform.core.AbstractTransform

getProgressMonitorWorkUnits, getTransformationDescriptor

Methods inherited from class com.ibm.xtools.transform.core.AbstractTransformElement

getAcceptCondition, getDescription, getId, getName, getProgressMonitor, setAcceptCondition, setDescription, setId, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidateEditTransformUtility

public ValidateEditTransformUtility(ITransformUtilityDescriptor descriptor)

Constructor

Parameters:

descriptor - the descriptor for this utility

Method Detail

addAffectedFile

public static void addAffectedFile(ITransformContext context,
                                   org.eclipse.core.resources.IFile file)

Add a file to the list of affected files.

Parameters:

context - the current context of the transformation execution

file - A file that will be created or modified by the transform.

addAffectedFiles

public static void addAffectedFiles(ITransformContext context,
                                    java.util.List fileList)

Add the given files to the list of affected files.

Parameters:

context - the current context of the transformation execution

fileList - a list of files (of type IFile)that will be created or modified by the transform.

getAffectedFiles

protected static java.util.HashSet getAffectedFiles(ITransformContext context)

Get the list of affected files from the context. If the list is not found, create one and add it to the root context.

Parameters:

context - the current context of the transformation execution

Returns:

A list of affected files.

doExecute

public void doExecute(ITransformContext context)
               throws java.lang.Exception

Description copied from class: TransformUtility

The specific task that this TransformUtility performs based on the data contained within the execution context.

Specified by:

doExecute in class TransformUtility

Parameters:

context - The execution context.

Throws:

java.lang.Exception

canAccept

public boolean canAccept(ITransformContext context)

Description copied from class: AbstractTransformElement

Using the context, determine if this transformation element should be executed.

The default implementation will make use of the condition if one is defined. Subclasses may override this method to provide more specialized acceptance criteria.

Overrides:

canAccept in class AbstractTransformElement

Parameters:

context - the current context of the transformation execution

Returns:

boolean - true if the transform element will execute with the context

reportError

protected void reportError(org.eclipse.core.runtime.IStatus status,
                           ITransformContext context)

Process error that occured during file validation. Can be overriden by subclasses to modify reaction to file validation error.

Parameters:

status - - file validation status

context - - the current context of the transformation execution