FileDocCategorySizeDatePackage
SOSCheckin.javaAPI DocApache Ant 1.703672Wed Dec 13 06:16:22 GMT 2006org.apache.tools.ant.taskdefs.optional.sos

SOSCheckin

public class SOSCheckin extends SOS
Commits and unlocks files in Visual SourceSafe via a SourceOffSite server.
ant.task
name="soscheckin" category="scm"

Fields Summary
Constructors Summary
Methods Summary
protected org.apache.tools.ant.types.CommandlinebuildCmdLine()
Build the command line.

CheckInFile required parameters: -server -name -password -database -project -file
CheckInFile optional parameters: -workdir -log -verbose -nocache -nocompression -soshome
CheckInProject required parameters: -server -name -password -database -project
CheckInProject optional parameters: workdir -recursive -log -verbose -nocache -nocompression -soshome

return
Commandline the generated command to be executed

        commandLine = new Commandline();

        // If we find a "file" attribute then act on a file otherwise act on a project
        if (getFilename() != null) {
            // add -command CheckInFile to the commandline
            commandLine.createArgument().setValue(SOSCmd.FLAG_COMMAND);
            commandLine.createArgument().setValue(SOSCmd.COMMAND_CHECKIN_FILE);
            // add -file xxxxx to the commandline
            commandLine.createArgument().setValue(SOSCmd.FLAG_FILE);
            commandLine.createArgument().setValue(getFilename());
        } else {
            // add -command CheckInProject to the commandline
            commandLine.createArgument().setValue(SOSCmd.FLAG_COMMAND);
            commandLine.createArgument().setValue(SOSCmd.COMMAND_CHECKIN_PROJECT);
            // look for a recursive option
            commandLine.createArgument().setValue(getRecursive());
        }

        getRequiredAttributes();
        getOptionalAttributes();

        // Look for a comment
        if (getComment() != null) {
            commandLine.createArgument().setValue(SOSCmd.FLAG_COMMENT);
            commandLine.createArgument().setValue(getComment());
        }
        return commandLine;
    
public voidsetComment(java.lang.String comment)
The comment to apply to all files being labelled.

param
comment The new comment value

        super.setInternalComment(comment);
    
public final voidsetFile(java.lang.String filename)
The filename to act upon. If no file is specified then the task acts upon the project.

param
filename The new file value

        super.setInternalFilename(filename);
    
public voidsetRecursive(boolean recursive)
Flag to recursively apply the action. Defaults to false.

param
recursive True for recursive operation.

        super.setInternalRecursive(recursive);