com.codemesh.terp.ant.compiler.cpp
Class OptionsOption

java.lang.Object
  com.codemesh.terp.ant.compiler.AbstractCompilerOption<CppCompiler>
      com.codemesh.terp.ant.compiler.cpp.OptionsOption

All Implemented Interfaces:

CompilerOption<CppCompiler>, CppCompilerOptionsSource

public class OptionsOption
extends AbstractCompilerOption<CppCompiler>
implements CppCompilerOptionsSource

An option referencing an externally defined set of compiler options that are to be included by reference.

Constructor Summary

OptionsOption()

Method Summary

void	addCommands(java.util.List<java.lang.String> commandList, CppCompiler compiler, CompilerPhase phase) Adds the compiler switches repreesnted by this option to the list of switches.
boolean	appliesTo(CppCompiler compiler, CompilerPhase phase) Returns true if this compiler option applies to the given compiler and compiler phase.
CppCompilerOptions	getReferenced()
java.lang.String	getRefId() Returns the identifier of the external set of compiler options.
void	setRefId(java.lang.String refId) Sets the id under which the external set of compiler options is known.

Methods inherited from class com.codemesh.terp.ant.compiler.AbstractCompilerOption

expand, expand, getIf, getProject, getUnless, quoteIfNecessary, satisfies, setIf, setProject, setUnless

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionsOption

public OptionsOption()

Method Detail

getRefId

public java.lang.String getRefId()

Returns the identifier of the external set of compiler options.

Returns:

an identifier.

setRefId

public void setRefId(java.lang.String refId)

Sets the id under which the external set of compiler options is known.

Parameters:

refId - the options identifier.

getReferenced

public CppCompilerOptions getReferenced()

Specified by:

getReferenced in interface CppCompilerOptionsSource

addCommands

public void addCommands(java.util.List<java.lang.String> commandList,
                        CppCompiler compiler,
                        CompilerPhase phase)

Adds the compiler switches repreesnted by this option to the list of switches. Some compiler options may result in more than one switch being added to a compiler invocation. Other compiler options may result in different options being added in different phases (compilation vs. linking) of the build.

This method is called by the compiler repeatedly with different values for the compiler phase to account for these possibilities.

Specified by:

addCommands in interface CompilerOption<CppCompiler>

Parameters:

commandList - the list to which the compiler switches represented by this option (if any) are added.

compiler - the compiler for which we're doing this.

phase - the compiler phase in wihch we're doing this.

appliesTo

public boolean appliesTo(CppCompiler compiler,
                         CompilerPhase phase)

Returns true if this compiler option applies to the given compiler and compiler phase. Not every option has switches to contribute for every compiler and every compilation phase. This method allows a quick, inexpensive check to filter out potentially more expensive calls later on.

Specified by:

appliesTo in interface CompilerOption<CppCompiler>

Parameters:

compiler - the compiler for which we're asking.

phase - the compiler phase we're executing.

Returns: