Package org.apache.tools.ant.util.facade
Class FacadeTaskHelper
- java.lang.Object
- 
- org.apache.tools.ant.util.facade.FacadeTaskHelper
 
- 
 public class FacadeTaskHelper extends java.lang.ObjectHelper class for facade implementations - encapsulates treatment of explicit implementation choices, magic properties and implementation specific command line arguments.- Since:
- Ant 1.5
 
- 
- 
Constructor SummaryConstructors Constructor Description FacadeTaskHelper(java.lang.String defaultValue)FacadeTaskHelper(java.lang.String defaultValue, java.lang.String magicValue)
 - 
Method SummaryModifier and Type Method Description voidaddImplementationArgument(ImplementationSpecificArgument arg)Command line argument.java.lang.String[]getArgs()Retrieves the command line arguments enabled for the current facade implementation.java.lang.StringgetExplicitChoice()Retrieves the explicit user choice.java.lang.StringgetImplementation()Retrieves the implementation.PathgetImplementationClasspath(Project project)The classpath to use when loading the implementation.booleanhasBeenSet()Tests whether the implementation has been chosen by the user (either via a magic property or explicitly.voidsetImplementation(java.lang.String userChoice)Used for explicit user choices.voidsetMagicValue(java.lang.String magicValue)Used to set the value of the magic property.
 
- 
- 
- 
Constructor Detail- 
FacadeTaskHelperpublic FacadeTaskHelper(java.lang.String defaultValue) - Parameters:
- defaultValue- The default value for the implementation. Must not be null.
 
 - 
FacadeTaskHelperpublic FacadeTaskHelper(java.lang.String defaultValue, java.lang.String magicValue)- Parameters:
- defaultValue- The default value for the implementation. Must not be null.
- magicValue- the value of a magic property that may hold a user. choice. May be null.
 
 
- 
 - 
Method Detail- 
setMagicValuepublic void setMagicValue(java.lang.String magicValue) Used to set the value of the magic property.- Parameters:
- magicValue- the value of a magic property that may hold a user.
 
 - 
setImplementationpublic void setImplementation(java.lang.String userChoice) Used for explicit user choices.- Parameters:
- userChoice- the explicitly chosen implementation.
 
 - 
getImplementationpublic java.lang.String getImplementation() Retrieves the implementation.- Returns:
- the implementation.
 
 - 
getExplicitChoicepublic java.lang.String getExplicitChoice() Retrieves the explicit user choice.- Returns:
- the explicit user choice.
 
 - 
addImplementationArgumentpublic void addImplementationArgument(ImplementationSpecificArgument arg) Command line argument.- Parameters:
- arg- an argument to add.
 
 - 
getArgspublic java.lang.String[] getArgs() Retrieves the command line arguments enabled for the current facade implementation.- Returns:
- an array of command line arguments.
 
 - 
hasBeenSetpublic boolean hasBeenSet() Tests whether the implementation has been chosen by the user (either via a magic property or explicitly.- Returns:
- true if magic or user choice has be set.
- Since:
- Ant 1.5.2
 
 
- 
 
-