Return-Path: Delivered-To: apmail-ant-dev-archive@www.apache.org Received: (qmail 4587 invoked from network); 28 Jan 2005 13:50:57 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199) by minotaur-2.apache.org with SMTP; 28 Jan 2005 13:50:57 -0000 Received: (qmail 10631 invoked by uid 500); 28 Jan 2005 13:50:55 -0000 Delivered-To: apmail-ant-dev-archive@ant.apache.org Received: (qmail 10569 invoked by uid 500); 28 Jan 2005 13:50:55 -0000 Mailing-List: contact dev-help@ant.apache.org; run by ezmlm Precedence: bulk List-Unsubscribe: List-Subscribe: List-Help: List-Post: List-Id: "Ant Developers List" Reply-To: "Ant Developers List" Delivered-To: mailing list dev@ant.apache.org Received: (qmail 10535 invoked by uid 500); 28 Jan 2005 13:50:55 -0000 Received: (qmail 10532 invoked by uid 99); 28 Jan 2005 13:50:54 -0000 X-ASF-Spam-Status: No, hits=-9.8 required=10.0 tests=ALL_TRUSTED,NO_REAL_NAME X-Spam-Check-By: apache.org Received: from minotaur.apache.org (HELO minotaur.apache.org) (209.237.227.194) by apache.org (qpsmtpd/0.28) with SMTP; Fri, 28 Jan 2005 05:50:54 -0800 Received: (qmail 4553 invoked by uid 1539); 28 Jan 2005 13:50:53 -0000 Date: 28 Jan 2005 13:50:53 -0000 Message-ID: <20050128135053.4552.qmail@minotaur.apache.org> From: peterreilly@apache.org To: ant-cvs@apache.org Subject: cvs commit: ant/src/main/org/apache/tools/ant/taskdefs/optional/sos SOS.java SOSCmd.java X-Virus-Checked: Checked X-Spam-Rating: minotaur-2.apache.org 1.6.2 0/1000/N peterreilly 2005/01/28 05:50:53 Modified: src/main/org/apache/tools/ant/taskdefs/optional/sos SOS.java SOSCmd.java Log: javadoc Revision Changes Path 1.21 +56 -36 ant/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOS.java Index: SOS.java =================================================================== RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOS.java,v retrieving revision 1.20 retrieving revision 1.21 diff -u -r1.20 -r1.21 --- SOS.java 9 Mar 2004 16:48:36 -0000 1.20 +++ SOS.java 28 Jan 2005 13:50:53 -0000 1.21 @@ -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. @@ -28,7 +28,7 @@ /** * A base class for creating tasks for executing commands on SourceOffSite. * - * These tasks were inspired by the VSS tasks + * These tasks were inspired by the VSS tasks. * */ @@ -52,7 +52,7 @@ private boolean recursive = false; private boolean verbose = false; - /** Commandline to be executed */ + /** Commandline to be executed. */ protected Commandline commandLine; /** @@ -79,7 +79,7 @@ * The directory where soscmd(.exe) is located. * soscmd must be on the path if omitted. * - * @param dir The new sosCmd value + * @param dir The new sosCmd value. */ public final void setSosCmd(String dir) { sosCmdDir = Project.translatePath(dir); @@ -88,7 +88,7 @@ /** * The SourceSafe username. * - * @param username The new username value + * @param username The new username value. * * @ant.attribute group="required" */ @@ -99,7 +99,7 @@ /** * The SourceSafe password. * - * @param password The new password value + * @param password The new password value. */ public final void setPassword(String password) { sosPassword = password; @@ -108,7 +108,7 @@ /** * The SourceSafe project path. * - * @param projectpath The new projectpath value + * @param projectpath The new projectpath value. * * @ant.attribute group="required" */ @@ -123,7 +123,7 @@ /** * The path to the location of the ss.ini file. * - * @param vssServerPath The new vssServerPath value + * @param vssServerPath The new vssServerPath value. * * @ant.attribute group="required" */ @@ -134,7 +134,7 @@ /** * Path to the SourceOffSite home directory. * - * @param sosHome The new sosHome value + * @param sosHome The new sosHome value. */ public final void setSosHome(String sosHome) { this.sosHome = sosHome; @@ -144,7 +144,7 @@ * The address and port of SourceOffSite Server, * for example 192.168.0.1:8888. * - * @param sosServerPath The new sosServerPath value + * @param sosServerPath The new sosServerPath value. * * @ant.attribute group="required" */ @@ -155,7 +155,7 @@ /** * Override the working directory and get to the specified path. * - * @param path The new localPath value + * @param path The new localPath value. */ public final void setLocalPath(Path path) { localPath = path.toString(); @@ -172,22 +172,42 @@ // Special setters for the sub-classes + /** + * Set the file name. + * @param file the filename to use. + */ protected void setInternalFilename(String file) { filename = file; } + /** + * Set the recursive flag. + * @param recurse if true use the recursive flag on the command line. + */ protected void setInternalRecursive(boolean recurse) { recursive = recurse; } + /** + * Set the comment text. + * @param text the comment text to use. + */ protected void setInternalComment(String text) { comment = text; } + /** + * Set the label. + * @param text the label to use. + */ protected void setInternalLabel(String text) { label = text; } + /** + * Set the version. + * @param text the version to use. + */ protected void setInternalVersion(String text) { version = text; } @@ -195,7 +215,7 @@ /** * Get the executable to run. Add the path if it was specifed in the build file * - * @return the executable to run + * @return the executable to run. */ protected String getSosCommand() { if (sosCmdDir == null) { @@ -207,7 +227,7 @@ /** * Get the comment - * @return if it was set, null if not + * @return if it was set, null if not. */ protected String getComment() { return comment; @@ -215,7 +235,7 @@ /** * Get the version - * @return if it was set, null if not + * @return if it was set, null if not. */ protected String getVersion() { return version; @@ -223,7 +243,7 @@ /** * Get the label - * @return if it was set, null if not + * @return if it was set, null if not. */ protected String getLabel() { return label; @@ -231,7 +251,7 @@ /** * Get the username - * @return if it was set, null if not + * @return if it was set, null if not. */ protected String getUsername() { return sosUsername; @@ -239,7 +259,7 @@ /** * Get the password - * @return empty string if it wans't set + * @return empty string if it wasn't set. */ protected String getPassword() { return sosPassword; @@ -247,7 +267,7 @@ /** * Get the project path - * @return if it was set, null if not + * @return if it was set, null if not. */ protected String getProjectPath() { return projectPath; @@ -255,68 +275,68 @@ /** * Get the VSS server path - * @return if it was set, null if not + * @return if it was set, null if not. */ protected String getVssServerPath() { return vssServerPath; } /** - * Get the SOS home directory - * @return if it was set, null if not + * Get the SOS home directory. + * @return if it was set, null if not. */ protected String getSosHome() { return sosHome; } /** - * Get the SOS serve path - * @return if it was set, null if not + * Get the SOS serve path. + * @return if it was set, null if not. */ protected String getSosServerPath() { return sosServerPath; } /** - * Get the filename to be acted upon - * @return if it was set, null if not + * Get the filename to be acted upon. + * @return if it was set, null if not. */ protected String getFilename() { return filename; } /** - * Get the NoCompress flag + * Get the NoCompress flag. * * @return the 'nocompress' Flag if the attribute was 'true', - * otherwise an empty string + * otherwise an empty string. */ protected String getNoCompress() { return noCompress ? FLAG_NO_COMPRESSION : ""; } /** - * Get the NoCache flag + * Get the NoCache flag. * - * @return the 'nocache' Flag if the attribute was 'true', otherwise an empty string + * @return the 'nocache' Flag if the attribute was 'true', otherwise an empty string. */ protected String getNoCache() { return noCache ? FLAG_NO_CACHE : ""; } /** - * Get the 'verbose' Flag + * Get the 'verbose' Flag. * - * @return the 'verbose' Flag if the attribute was 'true', otherwise an empty string + * @return the 'verbose' Flag if the attribute was 'true', otherwise an empty string. */ protected String getVerbose() { return verbose ? FLAG_VERBOSE : ""; } /** - * Get the 'recursive' Flag + * Get the 'recursive' Flag. * - * @return the 'recursive' Flag if the attribute was 'true', otherwise an empty string + * @return the 'recursive' Flag if the attribute was 'true', otherwise an empty string. */ protected String getRecursive() { return recursive ? FLAG_RECURSION : ""; @@ -325,9 +345,9 @@ /** * Builds and returns the working directory. *

- * The localpath is created if it didn't exist + * The localpath is created if it didn't exist. * - * @return the absolute path of the working directory + * @return the absolute path of the working directory. */ protected String getLocalPath() { if (localPath == null) { @@ -359,7 +379,7 @@ /** * Execute the created command line. * - * @throws BuildException + * @throws BuildException on error. */ public void execute() throws BuildException { 1.11 +28 -1 ant/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.java Index: SOSCmd.java =================================================================== RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.java,v retrieving revision 1.10 retrieving revision 1.11 diff -u -r1.10 -r1.11 --- SOSCmd.java 9 Mar 2004 16:48:36 -0000 1.10 +++ SOSCmd.java 28 Jan 2005 13:50:53 -0000 1.11 @@ -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. @@ -22,31 +22,58 @@ */ public interface SOSCmd { // soscmd Command options + /** The sos executable */ String COMMAND_SOS_EXE = "soscmd"; + /** The get file command */ String COMMAND_GET_FILE = "GetFile"; + /** The get project command */ String COMMAND_GET_PROJECT = "GetProject"; + /** The checkout file command */ String COMMAND_CHECKOUT_FILE = "CheckOutFile"; + /** The checkout project command */ String COMMAND_CHECKOUT_PROJECT = "CheckOutProject"; + /** The checkin file command */ String COMMAND_CHECKIN_FILE = "CheckInFile"; + /** The checkin project command */ String COMMAND_CHECKIN_PROJECT = "CheckInProject"; + /** The get history command */ String COMMAND_HISTORY = "GetFileHistory"; + /** The add label command */ String COMMAND_LABEL = "AddLabel"; + /** The project prefix */ String PROJECT_PREFIX = "$"; + // soscmd Option flags + /** The command option */ String FLAG_COMMAND = "-command"; + /** The database (vss server) option */ String FLAG_VSS_SERVER = "-database"; + /** The username option */ String FLAG_USERNAME = "-name"; + /** The password option */ String FLAG_PASSWORD = "-password"; + /** The log option */ String FLAG_COMMENT = "-log"; + /** The workdir option */ String FLAG_WORKING_DIR = "-workdir"; + /** The recursive option */ String FLAG_RECURSION = "-recursive"; + /** The revision option */ String FLAG_VERSION = "-revision"; + /** The label option */ String FLAG_LABEL = "-label"; + /** The no compression option */ String FLAG_NO_COMPRESSION = "-nocompress"; + /** The no cache option */ String FLAG_NO_CACHE = "-nocache"; + /** The server option */ String FLAG_SOS_SERVER = "-server"; + /** The sos home option */ String FLAG_SOS_HOME = "-soshome"; + /** The project option */ String FLAG_PROJECT = "-project"; + /** The file option */ String FLAG_FILE = "-file"; + /** The verbose option */ String FLAG_VERBOSE = "-verbose"; } --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscribe@ant.apache.org For additional commands, e-mail: dev-help@ant.apache.org