Java Doc for MSVSS.java in » Build » ANT » org » apache » tools » ant » taskdefs » optional » vss » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Build » ANT » org.apache.tools.ant.taskdefs.optional.vss

Source Cross Reference Class Diagram Java Document (Java Doc)

org.apache.tools.ant .Task

org.apache.tools.ant.taskdefs.optional.vss .MSVSS

All known Subclasses:   org.apache.tools.ant.taskdefs.optional.vss .MSVSSCHECKIN,  org.apache.tools.ant.taskdefs.optional.vss .MSVSSHISTORY,  org.apache.tools.ant.taskdefs.optional.vss .MSVSSCREATE,  org.apache.tools.ant.taskdefs.optional.vss .MSVSSGET,  org.apache.tools.ant.taskdefs.optional.vss .MSVSSCP,  org.apache.tools.ant.taskdefs.optional.vss .MSVSSADD,  org.apache.tools.ant.taskdefs.optional.vss .MSVSSLABEL,  org.apache.tools.ant.taskdefs.optional.vss .MSVSSCHECKOUT,
MSVSS
abstract public class MSVSS extends Task implements MSVSSConstants(Code)
A base class for creating tasks for executing commands on Visual SourceSafe.
The class extends the 'exec' task as it operates by executing the ss.exe program supplied with SourceSafe. By default the task expects ss.exe to be in the path, you can override this be specifying the ssdir attribute.

This class provides set and get methods for 'login' and 'vsspath' attributes. It also contains constants for the flags that can be passed to SS.

Inner Class :public static class CurrentModUpdated extends EnumeratedAttribute
Inner Class :public static class WritableFiles extends EnumeratedAttribute

Method Summary
abstract Commandline buildCmdLine()
     Each sub-class must implemnt this method and return the constructed command line to be executed.
public void execute()
     Executes the task.
protected String getAutoresponse()
     Gets the auto response string.
protected String getComment()
     Gets the comment string.
public String getFileTimeStamp()
     Gets the value set for the FileTimeStamp.
protected String getGetLocalCopy()
     Builds and returns the -G- flag if required.
protected String getLabel()
     Gets the label string.
protected String getLocalpath()
     Gets the localpath string.
protected String getLogin()
     Gets the login string.
protected String getOutput()
     Gets the output file string.
protected String getQuiet()
     Gets the quiet string.
protected String getRecursive()
     Gets the recursive string.
protected String getSSCommand()
     Gets the sscommand string.
protected String getStyle()
     Gets the style string.
protected String getUser()
     Gets the user string.
protected String getVersion()
     Gets the version string.
protected String getVersionDate()
     Gets the Version date string.
protected String getVersionDateLabel()
     Gets the version string.
protected String getVersionLabel()
     Gets the version string.
protected String getVsspath()
     Gets the vssserverpath string.
protected String getWritable()
     Gets the writable string.
public String getWritableFiles()
     Gets the value to determine the behaviour when encountering writable files.
final public void setFailOnError(boolean failOnError)
     Indicates if the build should fail if the Sourcesafe command does.
protected void setInternalAutoResponse(String autoResponse)
     Set the auto response attribute.
protected void setInternalComment(String comment)
     Set the internal comment attribute.
protected void setInternalDate(String date)
     Set the date attribute.
protected void setInternalDateFormat(DateFormat dateFormat)
     Set the date format attribute.
protected void setInternalFailOnError(boolean failOnError)
     Set the failOnError attribute.
protected void setInternalFileTimeStamp(CurrentModUpdated timestamp)
     Set the timestamp attribute.
protected void setInternalFromDate(String fromDate)
     Set the from date attribute.
protected void setInternalFromLabel(String fromLabel)
     Set the from label attribute.
protected void setInternalGetLocalCopy(boolean getLocalCopy)
     Set the getLocalCopy attribute.
protected void setInternalLabel(String label)
     Set the label attribute.
protected void setInternalLocalPath(String localPath)
     Set the local path comment attribute.
protected void setInternalNumDays(int numDays)
     Set the num days attribute.
protected void setInternalOutputFilename(String outputFileName)
     Set the outputFileName comment attribute.
protected void setInternalQuiet(boolean quiet)
     Set the quiet attribute.
protected void setInternalRecursive(boolean recursive)
     Set the recursive attribute.
protected void setInternalStyle(String style)
     Set the style attribute.
protected void setInternalToDate(String toDate)
     Set the to date attribute.
protected void setInternalToLabel(String toLabel)
     Set the to label attribute.
protected void setInternalUser(String user)
     Set the user attribute.
protected void setInternalVersion(String version)
     Set the version attribute.
protected void setInternalWritable(boolean writable)
     Set the writable attribute.
protected void setInternalWritableFiles(WritableFiles writableFiles)
     Set the writableFiles attribute.
final public void setLogin(String vssLogin)
     Login to use when accessing VSS, formatted as "username,password".
final public void setServerpath(String serverPath)
     Directory where srssafe.ini resides.
final public void setSsdir(String dir)
     Directory where ss.exe resides.
final public void setVsspath(String vssPath)
     SourceSafe path which specifies the project/file(s) you wish to perform the action on.

Method Detail
buildCmdLine
abstract Commandline buildCmdLine()(Code)
Each sub-class must implemnt this method and return the constructed command line to be executed. It is up to the sub-task to determine the required attrubutes and their order. The Constructed command line.

execute
public void execute() throws BuildException(Code)
Executes the task.
Builds a command line to execute ss.exe and then calls Exec's run method to execute the command line.
throws:
  BuildException - if the command cannot execute.

getAutoresponse
protected String getAutoresponse()(Code)
Gets the auto response string. This can be Y "-I-Y" or N "-I-N". The default value "-I-" if autoresponse is not set.

getComment
protected String getComment()(Code)
Gets the comment string. "-Ccomment text" A comment of "-" if comment is not set.

getFileTimeStamp
public String getFileTimeStamp()(Code)
Gets the value set for the FileTimeStamp. if it equals "current" then we return -GTC if it equals "modified" then we return -GTM if it equals "updated" then we return -GTU otherwise we return -GTC The default file time flag, if not set.

getGetLocalCopy
protected String getGetLocalCopy()(Code)
Builds and returns the -G- flag if required. An empty string if get local copy is true.

getLabel
protected String getLabel()(Code)
Gets the label string. "-Lbuild1" Max label length is 32 chars An empty string if label is not set.

getLocalpath
protected String getLocalpath()(Code)
Gets the localpath string. "-GLc:\source"
The localpath is created if it didn't exist. An empty string if localpath is not set.

getLogin
protected String getLogin()(Code)
Gets the login string. This can be user and password, "-Yuser,password" or just user "-Yuser". An empty string if login is not set.

getOutput
protected String getOutput()(Code)
Gets the output file string. "-Ooutput.file" An empty string if user is not set.

getQuiet
protected String getQuiet()(Code)
Gets the quiet string. -O- An empty string if quiet is not set or is false.

getRecursive
protected String getRecursive()(Code)
Gets the recursive string. "-R" An empty string if recursive is not set or is false.

getSSCommand
protected String getSSCommand()(Code)
Gets the sscommand string. "ss" or "c:\path\to\ss" The path to ss.exe or just ss if sscommand is not set.

getStyle
protected String getStyle()(Code)
Gets the style string. "-Lbuild1" An empty string if label is not set.

getUser
protected String getUser()(Code)
Gets the user string. "-Uusername" An empty string if user is not set.

getVersion
protected String getVersion()(Code)
Gets the version string. An empty string if a version is not set.

getVersionDate
protected String getVersionDate() throws BuildException(Code)
Gets the Version date string. An empty string if neither Todate or from date are set.
throws:
  BuildException - if there is an error.

getVersionDateLabel
protected String getVersionDateLabel()(Code)
Gets the version string. Returns the first specified of version "-V1.0", date "-Vd01.01.01", label "-Vlbuild1". An empty string if a version, date and label are not set.

getVersionLabel
protected String getVersionLabel()(Code)
Gets the version string. This can be to-from "-VLbuild2~Lbuild1", from "~Lbuild1" or to "-VLbuild2". An empty string if neither tolabel or fromlabel are set.

getVsspath
protected String getVsspath()(Code)
Gets the vssserverpath string. null if vssserverpath is not set.

getWritable
protected String getWritable()(Code)
Gets the writable string. "-W" An empty string if writable is not set or is false.

getWritableFiles
public String getWritableFiles()(Code)
Gets the value to determine the behaviour when encountering writable files. An empty String, if not set.

setFailOnError
final public void setFailOnError(boolean failOnError)(Code)
Indicates if the build should fail if the Sourcesafe command does. Defaults to true.
Parameters:
  failOnError - True if task should fail on any error.

setInternalAutoResponse
protected void setInternalAutoResponse(String autoResponse)(Code)
Set the auto response attribute.
Parameters:
  autoResponse - the value to use.

setInternalComment
protected void setInternalComment(String comment)(Code)
Set the internal comment attribute.
Parameters:
  comment - the value to use.

setInternalDate
protected void setInternalDate(String date)(Code)
Set the date attribute.
Parameters:
  date - the value to use.

setInternalDateFormat
protected void setInternalDateFormat(DateFormat dateFormat)(Code)
Set the date format attribute.
Parameters:
  dateFormat - the value to use.

setInternalFailOnError
protected void setInternalFailOnError(boolean failOnError)(Code)
Set the failOnError attribute.
Parameters:
  failOnError - the value to use.

setInternalFileTimeStamp
protected void setInternalFileTimeStamp(CurrentModUpdated timestamp)(Code)
Set the timestamp attribute.
Parameters:
  timestamp - the value to use.

setInternalFromDate
protected void setInternalFromDate(String fromDate)(Code)
Set the from date attribute.
Parameters:
  fromDate - the value to use.

setInternalFromLabel
protected void setInternalFromLabel(String fromLabel)(Code)
Set the from label attribute.
Parameters:
  fromLabel - the value to use.

setInternalGetLocalCopy
protected void setInternalGetLocalCopy(boolean getLocalCopy)(Code)
Set the getLocalCopy attribute.
Parameters:
  getLocalCopy - the value to use.

setInternalLabel
protected void setInternalLabel(String label)(Code)
Set the label attribute.
Parameters:
  label - the value to use.

setInternalLocalPath
protected void setInternalLocalPath(String localPath)(Code)
Set the local path comment attribute.
Parameters:
  localPath - the value to use.

setInternalNumDays
protected void setInternalNumDays(int numDays)(Code)
Set the num days attribute.
Parameters:
  numDays - the value to use.

setInternalOutputFilename
protected void setInternalOutputFilename(String outputFileName)(Code)
Set the outputFileName comment attribute.
Parameters:
  outputFileName - the value to use.

setInternalQuiet
protected void setInternalQuiet(boolean quiet)(Code)
Set the quiet attribute.
Parameters:
  quiet - the value to use.

setInternalRecursive
protected void setInternalRecursive(boolean recursive)(Code)
Set the recursive attribute.
Parameters:
  recursive - the value to use.

setInternalStyle
protected void setInternalStyle(String style)(Code)
Set the style attribute.
Parameters:
  style - the value to use.

setInternalToDate
protected void setInternalToDate(String toDate)(Code)
Set the to date attribute.
Parameters:
  toDate - the value to use.

setInternalToLabel
protected void setInternalToLabel(String toLabel)(Code)
Set the to label attribute.
Parameters:
  toLabel - the value to use.

setInternalUser
protected void setInternalUser(String user)(Code)
Set the user attribute.
Parameters:
  user - the value to use.

setInternalVersion
protected void setInternalVersion(String version)(Code)
Set the version attribute.
Parameters:
  version - the value to use.

setInternalWritable
protected void setInternalWritable(boolean writable)(Code)
Set the writable attribute.
Parameters:
  writable - the value to use.

setInternalWritableFiles
protected void setInternalWritableFiles(WritableFiles writableFiles)(Code)
Set the writableFiles attribute.
Parameters:
  writableFiles - the value to use.

setLogin
final public void setLogin(String vssLogin)(Code)
Login to use when accessing VSS, formatted as "username,password".
You can omit the password if your database is not password protected. If you have a password and omit it, Ant will hang.
Parameters:
  vssLogin - The login string to use.

setServerpath
final public void setServerpath(String serverPath)(Code)
Directory where srssafe.ini resides.
Parameters:
  serverPath - The path to the VSS server.

setSsdir
final public void setSsdir(String dir)(Code)
Directory where ss.exe resides. By default the task expects it to be in the PATH.
Parameters:
  dir - The directory containing ss.exe.

setVsspath
final public void setVsspath(String vssPath)(Code)
SourceSafe path which specifies the project/file(s) you wish to perform the action on.
A prefix of 'vss://' will be removed if specified.
Parameters:
  vssPath - The VSS project path.

Fields inherited from org.apache.tools.ant.Task
protected Target target(Code)(Java Doc)
protected String taskName(Code)(Java Doc)
protected String taskType(Code)(Java Doc)
protected RuntimeConfigurable wrapper(Code)(Java Doc)

Methods inherited from org.apache.tools.ant.Task
final public void bindToOwner(Task owner)(Code)(Java Doc)
public void execute() throws BuildException(Code)(Java Doc)
public Target getOwningTarget()(Code)(Java Doc)
public RuntimeConfigurable getRuntimeConfigurableWrapper()(Code)(Java Doc)
public String getTaskName()(Code)(Java Doc)
public String getTaskType()(Code)(Java Doc)
protected RuntimeConfigurable getWrapper()(Code)(Java Doc)
protected void handleErrorFlush(String output)(Code)(Java Doc)
protected void handleErrorOutput(String output)(Code)(Java Doc)
protected void handleFlush(String output)(Code)(Java Doc)
protected int handleInput(byte[] buffer, int offset, int length) throws IOException(Code)(Java Doc)
protected void handleOutput(String output)(Code)(Java Doc)
public void init() throws BuildException(Code)(Java Doc)
final protected boolean isInvalid()(Code)(Java Doc)
public void log(String msg)(Code)(Java Doc)
public void log(String msg, int msgLevel)(Code)(Java Doc)
public void log(Throwable t, int msgLevel)(Code)(Java Doc)
public void log(String msg, Throwable t, int msgLevel)(Code)(Java Doc)
public void maybeConfigure() throws BuildException(Code)(Java Doc)
final public void perform()(Code)(Java Doc)
public void reconfigure()(Code)(Java Doc)
public void setOwningTarget(Target target)(Code)(Java Doc)
public void setRuntimeConfigurableWrapper(RuntimeConfigurable wrapper)(Code)(Java Doc)
public void setTaskName(String name)(Code)(Java Doc)
public void setTaskType(String type)(Code)(Java Doc)

w_w__w___.___j_a__v___a_2__s__.__c___o__m__ | Contact Us

All other trademarks are property of their respective owners.