ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From peterrei...@apache.org
Subject cvs commit: ant/src/main/org/apache/tools/ant/util/facade FacadeTaskHelper.java ImplementationSpecificArgument.java
Date Fri, 21 Jan 2005 16:37:51 GMT
peterreilly    2005/01/21 08:37:51

  Modified:    src/main/org/apache/tools/ant/util/facade
                        FacadeTaskHelper.java
                        ImplementationSpecificArgument.java
  Log:
  javadoc
  
  Revision  Changes    Path
  1.14      +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.13
  retrieving revision 1.14
  diff -u -r1.13 -r1.14
  --- FacadeTaskHelper.java	9 Mar 2004 16:48:54 -0000	1.13
  +++ FacadeTaskHelper.java	21 Jan 2005 16:37:51 -0000	1.14
  @@ -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.8       +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.7
  retrieving revision 1.8
  diff -u -r1.7 -r1.8
  --- ImplementationSpecificArgument.java	9 Mar 2004 16:48:54 -0000	1.7
  +++ ImplementationSpecificArgument.java	21 Jan 2005 16:37:51 -0000	1.8
  @@ -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: dev-unsubscribe@ant.apache.org
For additional commands, e-mail: dev-help@ant.apache.org


Mime
View raw message