Java Doc for SOS.java in  » Build » ANT » org » apache » tools » ant » taskdefs » optional » sos » 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
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net 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.sos 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.tools.ant.Task
   org.apache.tools.ant.taskdefs.optional.sos.SOS

All known Subclasses:   org.apache.tools.ant.taskdefs.optional.sos.SOSGet,  org.apache.tools.ant.taskdefs.optional.sos.SOSCheckout,  org.apache.tools.ant.taskdefs.optional.sos.SOSLabel,  org.apache.tools.ant.taskdefs.optional.sos.SOSCheckin,
SOS
abstract public class SOS extends Task implements SOSCmd(Code)
A base class for creating tasks for executing commands on SourceOffSite. These tasks were inspired by the VSS tasks.


Field Summary
protected  CommandlinecommandLine
     Commandline to be executed.


Method Summary
abstract  CommandlinebuildCmdLine()
     Subclasses implement the logic required to construct the command line.
public  voidexecute()
     Execute the created command line.
protected  StringgetComment()
    
protected  StringgetFilename()
     Get the filename to be acted upon.
protected  StringgetLabel()
    
protected  StringgetLocalPath()
     Builds and returns the working directory.
protected  StringgetNoCache()
     Get the NoCache flag.
protected  StringgetNoCompress()
     Get the NoCompress flag.
protected  voidgetOptionalAttributes()
     Adds the optional attributes to the command line.
protected  StringgetPassword()
    
protected  StringgetProjectPath()
    
protected  StringgetRecursive()
     Get the 'recursive' Flag.
protected  voidgetRequiredAttributes()
     Sets the executable and add the required attributes to the command line.
protected  StringgetSosCommand()
     Get the executable to run.
protected  StringgetSosHome()
     Get the SOS home directory.
protected  StringgetSosServerPath()
     Get the SOS serve path.
protected  StringgetUsername()
    
protected  StringgetVerbose()
     Get the 'verbose' Flag.
protected  StringgetVersion()
    
protected  StringgetVssServerPath()
    
protected  intrun(Commandline cmd)
     Execute the created command line.
Parameters:
  cmd - The command line to run.
protected  voidsetInternalComment(String text)
     Set the comment text.
protected  voidsetInternalFilename(String file)
     Set the file name.
protected  voidsetInternalLabel(String text)
     Set the label.
protected  voidsetInternalRecursive(boolean recurse)
     Set the recursive flag.
protected  voidsetInternalVersion(String text)
     Set the version.
final public  voidsetLocalPath(Path path)
     Override the working directory and get to the specified path.
final public  voidsetNoCache(boolean nocache)
     Flag to disable the cache when set.
final public  voidsetNoCompress(boolean nocompress)
     Flag to disable compression when set.
final public  voidsetPassword(String password)
     The SourceSafe password.
final public  voidsetProjectPath(String projectpath)
     The SourceSafe project path.
final public  voidsetSosCmd(String dir)
     The directory where soscmd(.exe) is located.
final public  voidsetSosHome(String sosHome)
     Path to the SourceOffSite home directory.
final public  voidsetSosServerPath(String sosServerPath)
     The address and port of SourceOffSite Server, for example 192.168.0.1:8888.
final public  voidsetUsername(String username)
     The SourceSafe username.
public  voidsetVerbose(boolean verbose)
     Enable verbose output.
final public  voidsetVssServerPath(String vssServerPath)
     The path to the location of the ss.ini file.

Field Detail
commandLine
protected Commandline commandLine(Code)
Commandline to be executed.





Method Detail
buildCmdLine
abstract Commandline buildCmdLine()(Code)
Subclasses implement the logic required to construct the command line. The command line to execute.



execute
public void execute() throws BuildException(Code)
Execute the created command line.
throws:
  BuildException - on error.



getComment
protected String getComment()(Code)
Get the comment if it was set, null if not.



getFilename
protected String getFilename()(Code)
Get the filename to be acted upon. if it was set, null if not.



getLabel
protected String getLabel()(Code)
Get the label if it was set, null if not.



getLocalPath
protected String getLocalPath()(Code)
Builds and returns the working directory.

The localpath is created if it didn't exist. the absolute path of the working directory.




getNoCache
protected String getNoCache()(Code)
Get the NoCache flag. the 'nocache' Flag if the attribute was 'true', otherwise an empty string.



getNoCompress
protected String getNoCompress()(Code)
Get the NoCompress flag. the 'nocompress' Flag if the attribute was 'true',otherwise an empty string.



getOptionalAttributes
protected void getOptionalAttributes()(Code)
Adds the optional attributes to the command line.



getPassword
protected String getPassword()(Code)
Get the password empty string if it wasn't set.



getProjectPath
protected String getProjectPath()(Code)
Get the project path if it was set, null if not.



getRecursive
protected String getRecursive()(Code)
Get the 'recursive' Flag. the 'recursive' Flag if the attribute was 'true', otherwise an empty string.



getRequiredAttributes
protected void getRequiredAttributes()(Code)
Sets the executable and add the required attributes to the command line.



getSosCommand
protected String getSosCommand()(Code)
Get the executable to run. Add the path if it was specifed in the build file the executable to run.



getSosHome
protected String getSosHome()(Code)
Get the SOS home directory. if it was set, null if not.



getSosServerPath
protected String getSosServerPath()(Code)
Get the SOS serve path. if it was set, null if not.



getUsername
protected String getUsername()(Code)
Get the username if it was set, null if not.



getVerbose
protected String getVerbose()(Code)
Get the 'verbose' Flag. the 'verbose' Flag if the attribute was 'true', otherwise an empty string.



getVersion
protected String getVersion()(Code)
Get the version if it was set, null if not.



getVssServerPath
protected String getVssServerPath()(Code)
Get the VSS server path if it was set, null if not.



run
protected int run(Commandline cmd)(Code)
Execute the created command line.
Parameters:
  cmd - The command line to run. int the exit code.
throws:
  BuildException -



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



setInternalFilename
protected void setInternalFilename(String file)(Code)
Set the file name.
Parameters:
  file - the filename to use.



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



setInternalRecursive
protected void setInternalRecursive(boolean recurse)(Code)
Set the recursive flag.
Parameters:
  recurse - if true use the recursive flag on the command line.



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



setLocalPath
final public void setLocalPath(Path path)(Code)
Override the working directory and get to the specified path.
Parameters:
  path - The new localPath value.



setNoCache
final public void setNoCache(boolean nocache)(Code)
Flag to disable the cache when set. Required if SOSHOME is set as an environment variable. Defaults to false.
Parameters:
  nocache - True to disable caching.



setNoCompress
final public void setNoCompress(boolean nocompress)(Code)
Flag to disable compression when set. Defaults to false.
Parameters:
  nocompress - True to disable compression.



setPassword
final public void setPassword(String password)(Code)
The SourceSafe password.
Parameters:
  password - The new password value.



setProjectPath
final public void setProjectPath(String projectpath)(Code)
The SourceSafe project path.
Parameters:
  projectpath - The new projectpath value.



setSosCmd
final public void setSosCmd(String dir)(Code)
The directory where soscmd(.exe) is located. soscmd must be on the path if omitted.
Parameters:
  dir - The new sosCmd value.



setSosHome
final public void setSosHome(String sosHome)(Code)
Path to the SourceOffSite home directory.
Parameters:
  sosHome - The new sosHome value.



setSosServerPath
final public void setSosServerPath(String sosServerPath)(Code)
The address and port of SourceOffSite Server, for example 192.168.0.1:8888.
Parameters:
  sosServerPath - The new sosServerPath value.



setUsername
final public void setUsername(String username)(Code)
The SourceSafe username.
Parameters:
  username - The new username value.



setVerbose
public void setVerbose(boolean verbose)(Code)
Enable verbose output. Defaults to false.
Parameters:
  verbose - True for verbose output.



setVssServerPath
final public void setVssServerPath(String vssServerPath)(Code)
The path to the location of the ss.ini file.
Parameters:
  vssServerPath - The new vssServerPath value.



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
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.