ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ste...@apache.org
Subject cvs commit: jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/starteam StarTeamCheckin.java StarTeamCheckout.java StarTeamLabel.java StarTeamList.java StarTeamTask.java TreeBasedTask.java
Date Sun, 23 Jun 2002 07:55:40 GMT
stevel      2002/06/23 00:55:40

  Modified:    src/main/org/apache/tools/ant/taskdefs/optional/starteam
                        Tag: ANT_15_BRANCH StarTeamCheckin.java
                        StarTeamCheckout.java StarTeamLabel.java
                        StarTeamList.java StarTeamTask.java
                        TreeBasedTask.java
  Log:
  starteam javadocs
  
  Revision  Changes    Path
  No                   revision
  
  
  No                   revision
  
  
  1.5.2.1   +9 -4      jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/starteam/StarTeamCheckin.java
  
  Index: StarTeamCheckin.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/starteam/StarTeamCheckin.java,v
  retrieving revision 1.5
  retrieving revision 1.5.2.1
  diff -u -r1.5 -r1.5.2.1
  --- StarTeamCheckin.java	12 Apr 2002 13:26:53 -0000	1.5
  +++ StarTeamCheckin.java	23 Jun 2002 07:55:39 -0000	1.5.2.1
  @@ -69,7 +69,9 @@
   import org.apache.tools.ant.Project;
   
   /**
  - * StarTeamCheckIn.java
  + * Checks files into a StarTeam project.  
  + * Optionally adds files and in the local tree that
  + * are not managed by the repository to its control.
    *
    *
    * Created: Sat Dec 15 20:26:07 2001
  @@ -118,7 +120,7 @@
       }
   
       /**
  -     * Set the value of comment.
  +     * Optional checkin comment to be saved with the file.
        * @param comment  Value to assign to comment.
        */
       public void setComment(String comment) {
  @@ -134,7 +136,8 @@
       }
   
       /**
  -     * Set the value of addUncontrolled.
  +     * if true, any files or folders NOT in StarTeam will be 
  +     * added to the repository.  Defaults to "false".
        * @param addUncontrolled  Value to assign to addUncontrolled.
        */
       public void setAddUncontrolled(boolean addUncontrolled) {
  @@ -150,7 +153,9 @@
       private int lockStatus = Item.LockType.UNCHANGED;
   
       /**
  -     * Set to do an unlocked checkout. Default is false;
  +     * Set to do an unlocked checkout; optional, default is false;
  +     * If true, file will be unlocked so that other users may
  +     * change it.  If false, lock status will not change.     
        * @param v  true means do an unlocked checkout
        *           false means leave status alone.
        */
  
  
  
  1.9.2.1   +7 -8      jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/starteam/StarTeamCheckout.java
  
  Index: StarTeamCheckout.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/starteam/StarTeamCheckout.java,v
  retrieving revision 1.9
  retrieving revision 1.9.2.1
  diff -u -r1.9 -r1.9.2.1
  --- StarTeamCheckout.java	12 Apr 2002 13:26:53 -0000	1.9
  +++ StarTeamCheckout.java	23 Jun 2002 07:55:39 -0000	1.9.2.1
  @@ -102,8 +102,8 @@
       private boolean deleteUncontrolled = true;
   
       /**
  -     * Set the attribute that tells ant if we want to create all directories
  -     * that are in the Starteam repository regardless if they are empty.
  +     * flag (defaults to true) to create all directories
  +     * that are in the Starteam repository even if they are empty.
        *
        * @param value  the value to set the attribute to.
        */
  @@ -112,9 +112,8 @@
       }
   
       /**
  -     * Sets the attribute that tells ant whether or not to remove local files
  -     * that are NOT found in the Starteam repository to the supplied value.
  -     *
  +     * Should all all local files <i>not<i> in StarTeam be deleted?
  +     * Optional, defaults to "true".     
        * @param value  the value to set the attribute to.
        */
       public void setDeleteUncontrolled(boolean value) {
  @@ -122,8 +121,8 @@
       }
   
       /**
  -     * Sets the label StarTeam is to use for checkout.
  -     *
  +     * Sets the label StarTeam is to use for checkout; defaults to the most recent file.
  +     * The label must exist in starteam or an exception will be thrown. 
        * @param label the label to be used
        */
       public void setLabel(String label) {
  @@ -142,7 +141,7 @@
       private int lockStatus = Item.LockType.UNCHANGED;
   
       /**
  -     * Set to do a locked checkout.  Default is false.
  +     * Set to do a locked checkout; optional default is false. 
        * @param v  True to do a locked checkout, false to checkout without
        *           changing status/.
        * @exception BuildException if both locked and unlocked are set true
  
  
  
  1.9.2.1   +10 -0     jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/starteam/StarTeamLabel.java
  
  Index: StarTeamLabel.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/starteam/StarTeamLabel.java,v
  retrieving revision 1.9
  retrieving revision 1.9.2.1
  diff -u -r1.9 -r1.9.2.1
  --- StarTeamLabel.java	15 Apr 2002 14:56:34 -0000	1.9
  +++ StarTeamLabel.java	23 Jun 2002 07:55:39 -0000	1.9.2.1
  @@ -105,14 +105,24 @@
               new SimpleDateFormat("yyyyMMddHHmmss");
   
   
  +    /**
  +    * The name to be given to the label; required.
  +    */
       public void setLabel(String label) {
           this.labelName = label;
       }
   
  +    /**
  +     * Optional description of the label to be stored in the StarTeam project.
  +     */
       public void setDescription(String description) {
           this.description = description;
       }
   
  +    /**
  +     * The timestamp of the build that will be stored with the label; required.  
  +     * Must be formatted <code>yyyyMMddHHmmss</code>
  +     */
       public void setLastBuild(String lastbuild) throws BuildException {
           try {
               Date lastBuildTime = DATE_FORMAT.parse(lastbuild);
  
  
  
  1.6.2.1   +3 -1      jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/starteam/StarTeamList.java
  
  Index: StarTeamList.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/starteam/StarTeamList.java,v
  retrieving revision 1.6
  retrieving revision 1.6.2.1
  diff -u -r1.6 -r1.6.2.1
  --- StarTeamList.java	15 Apr 2002 14:56:34 -0000	1.6
  +++ StarTeamList.java	23 Jun 2002 07:55:39 -0000	1.6.2.1
  @@ -79,7 +79,9 @@
   
   public class StarTeamList extends TreeBasedTask {
       /**
  -     * Sets the label StarTeam is to be listed.
  +     * List files, dates, and statuses as of this label; optional.
  +     * The label must exist in starteam or an exception will be thrown.  
  +     * If not specified, the most recent version of each file will be listed.
        *
        * @param label the label to be listed
        */
  
  
  
  1.6.2.1   +12 -9     jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.java
  
  Index: StarTeamTask.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.java,v
  retrieving revision 1.6
  retrieving revision 1.6.2.1
  diff -u -r1.6 -r1.6.2.1
  --- StarTeamTask.java	15 Apr 2002 12:11:49 -0000	1.6
  +++ StarTeamTask.java	23 Jun 2002 07:55:39 -0000	1.6.2.1
  @@ -120,8 +120,8 @@
       /////////////////////////////////////////////////////////
   
       /**
  -     * Set the name of StarTeamServer
  -     *
  +     * Set the name of StarTeamServer;
  +     * required if <tt>URL</tt> is not set.
        * @param servername a <code>String</code> value
        * @see #setURL(String)
        */
  @@ -140,8 +140,8 @@
       }
   
       /**
  -     * set the port number of the StarTeam connection
  -     *
  +     * set the port number of the StarTeam connection;
  +     * required if <tt>URL</tt> is not set.
        * @param serverport port number to be set
        * @see #setURL(String)
        */
  @@ -160,7 +160,8 @@
       }
   
       /**
  -     * set the name of the StarTeam project to be acted on
  +     * set the name of the StarTeam project to be acted on;
  +     * required if <tt>URL</tt> is not set.
        *
        * @param projectname the name of the StarTeam project to be acted on
        * @see #setURL(String)
  @@ -180,7 +181,8 @@
       }
   
       /**
  -     * set the name of the StarTeam view to be acted on
  +     * set the name of the StarTeam view to be acted on;
  +     * required if <tt>URL</tt> is not set.
        *
        * @param projectname the name of the StarTeam view to be acted on
        * @see #setURL(String)
  @@ -201,8 +203,9 @@
   
   
       /**
  -     * This is a convenience method for setting the server name, server port,
  -     * project name and project folder at one shot.
  +     * Set the server name, server port,
  +     * project name and project folder in one shot;
  +     * optional, but the server connection must be specified somehow. 
        *
        * @param url a <code>String</code> of the form
        *             "servername:portnum/project/view"
  @@ -272,7 +275,7 @@
       }
   
       /**
  -     * set the password to be used for login.
  +     * set the password to be used for login; required.
        *
        * @param password the password to be used for login
        */
  
  
  
  1.8.2.1   +17 -11    jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.java
  
  Index: TreeBasedTask.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.java,v
  retrieving revision 1.8
  retrieving revision 1.8.2.1
  diff -u -r1.8 -r1.8.2.1
  --- TreeBasedTask.java	15 Apr 2002 14:56:34 -0000	1.8
  +++ TreeBasedTask.java	23 Jun 2002 07:55:39 -0000	1.8.2.1
  @@ -157,7 +157,8 @@
       ///////////////////////////////////////////////////////////////
   
       /**
  -     * Set the root folder in the Starteam repository for this operation
  +     * Set the root of the subtree in the StarTeam repository from which to 
  +     * work; optional.  Defaults to the root folder of the view ('/').
        * @param rootStarteamFolder the root folder
        */
       public void setRootStarteamFolder(String rootStarteamFolder) {
  @@ -174,10 +175,10 @@
       }
   
       /**
  -     * Set the local folder corresponding to the
  -     * starteam folder for this operation.
  -     * If not specified, the StarTeam default will be used
  -     * the default is used.
  +     * Set the local folder that will be the root of the tree 
  +     * to which files are checked out; optional.
  +     * If this is not supplied, then the StarTeam "default folder" 
  +     * associated with <tt>rootstarteamfolder</tt> is used.
        * @param rootLocalFolder the local folder that will mirror
        *                        this.rootStarteamFolder
        */
  @@ -196,8 +197,7 @@
       }
   
       /**
  -     * sets the pattern of files to be included.  See setExcludes() for a
  -     * description
  +     * Declare files to include using standard <tt>includes</tt> patterns;
optional. 
        * @param includes A string of filter patterns to include. Separate the
        *                 patterns by spaces.
        * @see #getIncludes()
  @@ -210,7 +210,7 @@
   
       /**
        * Gets the patterns from the include filter. Rather that duplicate the
  -     * details of AntStarTeanCheckOut's filtering here, refer to these
  +     * details of AntStarTeamCheckOut's filtering here, refer to these
        * links:
        *
        * @return A string of filter patterns separated by spaces.
  @@ -223,7 +223,8 @@
       }
   
       /**
  -     * Sets the exclude filter. When filtering files, AntStarTeamCheckOut
  +     * Declare files to exclude using standard <tt>excludes</tt> patterns;
optional. 
  +     * When filtering files, AntStarTeamCheckOut
        * uses an unmodified version of <CODE>DirectoryScanner</CODE>'s
        * <CODE>match</CODE> method, so here are the patterns straight from the
        * Ant source code:
  @@ -297,7 +298,8 @@
       }
   
       /**
  -     * Set the value of recursive.
  +     * Flag to set to include files in subfolders in the operation; optional,
  +     * default true.
        * @param v  Value to assign to recursive.
        */
       public void setRecursive(boolean v) {
  @@ -313,7 +315,11 @@
       }
   
       /**
  -     * Set the value of forced.
  +     * Flag to force actions regardless of the status 
  +     * that StarTeam is maintaining for the file; optional, default false.  
  +     * If <tt>rootlocalfolder</tt> is set then 
  +     * this should be set "true" as otherwise the checkout will be based on statuses 
  +     * which do not relate to the target folder.  
        * @param v  Value to assign to forced.
        */
       public void setForced(boolean v) {
  
  
  

--
To unsubscribe, e-mail:   <mailto:ant-dev-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:ant-dev-help@jakarta.apache.org>


Mime
View raw message