peterreilly 2005/01/21 08:38:37
Modified: src/main/org/apache/tools/ant/util/facade Tag: ANT_16_BRANCH
FacadeTaskHelper.java
ImplementationSpecificArgument.java
Log:
javadoc
Revision Changes Path
No revision
No revision
1.9.2.5 +11 -5
ant/src/main/org/apache/tools/ant/util/facade/FacadeTaskHelper.java
Index: FacadeTaskHelper.java
===================================================================
RCS file:
/home/cvs/ant/src/main/org/apache/tools/ant/util/facade/FacadeTaskHelper.java,v
retrieving revision 1.9.2.4
retrieving revision 1.9.2.5
diff -u -r1.9.2.4 -r1.9.2.5
--- FacadeTaskHelper.java 9 Mar 2004 17:01:59 -0000 1.9.2.4
+++ FacadeTaskHelper.java 21 Jan 2005 16:38:37 -0000 1.9.2.5
@@ -1,5 +1,5 @@
/*
- * Copyright 2002-2004 The Apache Software Foundation
+ * Copyright 2002-2005 The Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -62,7 +62,7 @@
/**
* @param defaultValue The default value for the implementation.
* Must not be null.
- * @param magicValue the value of a magic property that may hold a user
+ * @param magicValue the value of a magic property that may hold a user.
* choice. May be null.
*/
public FacadeTaskHelper(String defaultValue, String magicValue) {
@@ -72,6 +72,7 @@
/**
* Used to set the value of the magic property.
+ * @param magicValue the value of a magic property that may hold a user.
*/
public void setMagicValue(String magicValue) {
this.magicValue = magicValue;
@@ -79,6 +80,7 @@
/**
* Used for explicit user choices.
+ * @param userChoice the explicitly chosen implementation.
*/
public void setImplementation(String userChoice) {
this.userChoice = userChoice;
@@ -86,6 +88,7 @@
/**
* Retrieves the implementation.
+ * @return the implementation.
*/
public String getImplementation() {
return userChoice != null ? userChoice
@@ -94,7 +97,8 @@
}
/**
- * Retrieves the explicit user choice
+ * Retrieves the explicit user choice.
+ * @return the explicit user choice.
*/
public String getExplicitChoice() {
return userChoice;
@@ -102,6 +106,7 @@
/**
* Command line argument.
+ * @param arg an argument to add.
*/
public void addImplementationArgument(ImplementationSpecificArgument
arg) {
args.addElement(arg);
@@ -110,6 +115,7 @@
/**
* Retrieves the command line arguments enabled for the current
* facade implementation.
+ * @return an array of command line arguements.
*/
public String[] getArgs() {
Vector tmp = new Vector(args.size());
@@ -129,7 +135,7 @@
/**
* Tests whether the implementation has been chosen by the user
* (either via a magic property or explicitly.
- *
+ * @return true if magic or user choice has be set.
* @since Ant 1.5.2
*/
public boolean hasBeenSet() {
1.3.2.5 +15 -2
ant/src/main/org/apache/tools/ant/util/facade/ImplementationSpecificArgument.java
Index: ImplementationSpecificArgument.java
===================================================================
RCS file:
/home/cvs/ant/src/main/org/apache/tools/ant/util/facade/ImplementationSpecificArgument.java,v
retrieving revision 1.3.2.4
retrieving revision 1.3.2.5
diff -u -r1.3.2.4 -r1.3.2.5
--- ImplementationSpecificArgument.java 9 Mar 2004 17:01:59 -0000
1.3.2.4
+++ ImplementationSpecificArgument.java 21 Jan 2005 16:38:37 -0000
1.3.2.5
@@ -1,5 +1,5 @@
/*
- * Copyright 2002,2004 The Apache Software Foundation
+ * Copyright 2002,2004-2005 The Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -30,14 +30,27 @@
public class ImplementationSpecificArgument extends Commandline.Argument {
private String impl;
+ /** Constructor for ImplementationSpecificArgument. */
public ImplementationSpecificArgument() {
super();
}
+ /**
+ * Set the implementation this argument is for.
+ * @param impl the implementation this command line argument is for.
+ */
public void setImplementation(String impl) {
this.impl = impl;
}
+ /**
+ * Return the parts this Argument consists of, if the
+ * implementation matches the chosen implementation.
+ * @see Commandline.Argument#getParts()
+ * @param chosenImpl the implementation to check against.
+ * @return the parts if the implemention matches or an zero length
+ * array if not.
+ */
public final String[] getParts(String chosenImpl) {
if (impl == null || impl.equals(chosenImpl)) {
return super.getParts();
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
