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

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

All Implemented Interfaces:

CompilerOption<CppCompiler>

public class LibraryOption
extends AbstractCompilerOption<CppCompiler>

An option for specifying link libraries.

Constructor Summary

LibraryOption()

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.
java.lang.Boolean	getDynamic() Returns true for dynamic, false for static, and null for default linkage.
java.lang.String	getIf() Returns the condition that must be satidifed to execute the implementing task.
java.lang.Boolean	getStatic() Returns true for static, false for dynamic, and null for default linkage.
java.lang.String	getUnless() Returns the condition that must not be satidifed to execute the implementing task.
boolean	satisfies(TerpContext ctx) Returns true if both conditions are met within the given terp context.
void	setDynamic(boolean dynamic) Specifies that dynamic linking is desired.
void	setIf(java.lang.String condition) Sets a condition that must be satisfied to execute the implementing task.
void	setNames(java.lang.String names) Sets a comma- or semicolon-separated list of library names to link with.
void	setStatic(boolean stat) Specifies that static linking is desired.
void	setUnless(java.lang.String condition) Sets a condition that must not be satisfied to execute the implementing task.

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

expand, expand, getProject, quoteIfNecessary, setProject

Methods inherited from class java.lang.Object

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

Constructor Detail

LibraryOption

public LibraryOption()

Method Detail

setNames

public void setNames(java.lang.String names)

Sets a comma- or semicolon-separated list of library names to link with.

Parameters:

names - a comma- or semicolon-separated list of library names

setStatic

public void setStatic(boolean stat)

Specifies that static linking is desired.

Parameters:

stat - true for static, false for dynamic.

See Also:

an alias with a negated argument.

getStatic

public java.lang.Boolean getStatic()

Returns true for static, false for dynamic, and null for default linkage.

Returns:

a boolean value or null for default.

setDynamic

public void setDynamic(boolean dynamic)

Specifies that dynamic linking is desired.

Parameters:

dynamic - true for dynamic, false for static.

See Also:

an alias with a negated argument.

getDynamic

public java.lang.Boolean getDynamic()

Returns true for dynamic, false for static, and null for default linkage.

Returns:

a boolean value or null for default.

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.

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.

Parameters:

compiler - the compiler for which we're asking.

phase - the compiler phase we're executing.

Returns:

getIf

public java.lang.String getIf()

Returns the condition that must be satidifed to execute the implementing task.

Specified by:

getIf in interface CompilerOption<CppCompiler>

Overrides:

getIf in class AbstractCompilerOption<CppCompiler>

Returns:

the boolean expression.

setIf

public void setIf(java.lang.String condition)

Sets a condition that must be satisfied to execute the implementing task.

Specified by:

setIf in interface CompilerOption<CppCompiler>

Overrides:

setIf in class AbstractCompilerOption<CppCompiler>

Parameters:

condition - a terp expression that must evaluate to a boolean value.

getUnless

public java.lang.String getUnless()

Returns the condition that must not be satidifed to execute the implementing task.

Specified by:

getUnless in interface CompilerOption<CppCompiler>

Overrides:

getUnless in class AbstractCompilerOption<CppCompiler>

Returns:

the boolean expression.

setUnless

public void setUnless(java.lang.String condition)

Sets a condition that must not be satisfied to execute the implementing task.

Specified by:

setUnless in interface CompilerOption<CppCompiler>

Overrides:

setUnless in class AbstractCompilerOption<CppCompiler>

Parameters:

condition - a terp expression that must evaluate to a boolean value.

satisfies

public boolean satisfies(TerpContext ctx)

Returns true if both conditions are met within the given terp context.

Specified by:

satisfies in interface CompilerOption<CppCompiler>

Overrides:

satisfies in class AbstractCompilerOption<CppCompiler>

Parameters:

ctx - the terp context in which the logical expressions are evaluated.

Returns:

true or false.