com.codemesh.terp.ant.devpartner
Interface FileCreating<T extends Tool>

All Superinterfaces:

ToolOption<T>

All Known Implementing Classes:

XmlFileOption

public interface FileCreating<T extends Tool>
extends ToolOption<T>

The interface implemented by all elements that result in the creation of one or more target files. Any compiler option could theoretically result in the creation of one or more files. A compiler wrapper needs to be aware of the files it creates so it can perform cleanup if necessary.

Implementing this interface allows compiler options to inform the compiler instance of the files that they will result in when used.

Method Summary

java.util.List<java.lang.String>

creates(T tool, ToolPhase phase) Returns a list of filenames representing the files that are created due to the presence of this tool option.

Methods inherited from interface com.codemesh.terp.ant.devpartner.ToolOption

addCommands, appliesTo, getIf, getUnless, satisfies, setIf, setUnless

Method Detail

creates

java.util.List<java.lang.String> creates(T tool,
                                         ToolPhase phase)

Returns a list of filenames representing the files that are created due to the presence of this tool option.

Parameters:

tool - the tool.

phase - the tool phase.

Returns:

a list of files, possibly empty.