Java Doc for Pvcs.java in  » Build » ANT » org » apache » tools » ant » taskdefs » optional » pvcs » 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.pvcs 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.tools.ant.Task
   org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs

Pvcs
public class Pvcs extends org.apache.tools.ant.Task (Code)
Extracts the latest edition of the source code from a PVCS repository. PVCS is a version control system developed by Merant.
Before using this tag, the user running ant must have access to the commands of PVCS (get and pcli) and must have access to the repository. Note that the way to specify the repository is platform dependent so use property to specify location of repository.
This version has been tested agains PVCS version 6.5 and 6.6 under Windows and Solaris. 19-04-2001

The task now has a more robust parser. It allows for platform independant file paths and supports file names with (). Thanks to Erik Husby for bringing the bug to my attention. 27-04-2001

UNC paths are now handled properly. Fix provided by Don Jeffery. He also added an UpdateOnly flag that, when true, conditions the PVCS get using the -U option to only update those files that have a modification time (in PVCS) that is newer than the existing workfile. 25-10-2002

Added a revision attribute that currently is a synonym for label, but in a future release the behavior of the label attribute will change to use the -v option of GET. See bug #13847 for discussion.




Constructor Summary
public  Pvcs()
    

Method Summary
public  voidaddPvcsproject(PvcsProject p)
     Specify a project within the PVCS repository to extract files from.
public  voidexecute()
    
public  StringgetConfig()
    
public  StringgetFilenameFormat()
     The filenameFormat attribute defines a MessageFormat string used to parse the output of the pcli command.
public  StringgetForce()
    
public  booleangetIgnoreReturnCode()
    
public  StringgetLabel()
    
public  StringgetLineStart()
     The lineStart attribute is used to parse the output of the pcli command.
public  StringgetPromotiongroup()
    
public  StringgetPvcsbin()
    
public  StringgetPvcsproject()
    
public  VectorgetPvcsprojects()
    
public  StringgetRepository()
    
public  StringgetRevision()
    
public  booleangetUpdateOnly()
     get the updateOnly attribute.
public  StringgetUserId()
     Get the userid.
public  StringgetWorkspace()
    
protected  intrunCmd(Commandline cmd, ExecuteStreamHandler out)
     Run the command.
Parameters:
  cmd - the command line to use.
Parameters:
  out - the output stream handler to use.
public  voidsetConfig(File f)
     Sets a configuration file other than the default to be used.
public  voidsetFilenameFormat(String f)
     The format of the folder names; optional.
public  voidsetForce(String f)
     Specifies the value of the force argument; optional. If set to yes all files that exists and are writable are overwritten.
public  voidsetIgnoreReturnCode(boolean b)
     If set to true the return value from executing the pvcs commands are ignored; optional, default false.
public  voidsetLabel(String l)
     Only files marked with this label are extracted; optional.
public  voidsetLineStart(String l)
     What a valid return value from PVCS looks like when it describes a file.
public  voidsetPromotiongroup(String w)
    
public  voidsetPvcsbin(String bin)
     Specifies the location of the PVCS bin directory; optional if on the PATH. On some systems the PVCS executables pcli and get are not found in the PATH.
public  voidsetPvcsproject(String prj)
    
public  voidsetRepository(String repo)
     The network name of the PVCS repository; required.
public  voidsetRevision(String r)
     Only files with this revision are extract; optional.
public  voidsetUpdateOnly(boolean l)
     If set to true files are fetched only if newer than existing local files; optional, default false.
public  voidsetUserId(String u)
    
public  voidsetWorkspace(String ws)
     Workspace to use; optional.


Constructor Detail
Pvcs
public Pvcs()(Code)
Creates a Pvcs object




Method Detail
addPvcsproject
public void addPvcsproject(PvcsProject p)(Code)
Specify a project within the PVCS repository to extract files from.
Parameters:
  p - the pvcs project to use.



execute
public void execute() throws org.apache.tools.ant.BuildException(Code)

exception:
  org.apache.tools.ant.BuildException - Something is stopping the build...



getConfig
public String getConfig()(Code)
returns the path of the configuration file to be used the path of the config file



getFilenameFormat
public String getFilenameFormat()(Code)
The filenameFormat attribute defines a MessageFormat string used to parse the output of the pcli command. It defaults to {0}-arc({1}). Repositories where the archive extension is not -arc should set this. the filename format attribute.



getForce
public String getForce()(Code)
Get value of force String



getIgnoreReturnCode
public boolean getIgnoreReturnCode()(Code)
Get value of ignorereturncode String



getLabel
public String getLabel()(Code)
Get value of label String



getLineStart
public String getLineStart()(Code)
The lineStart attribute is used to parse the output of the pcli command. It defaults to "P:. The parser already knows about / and \\, this property is useful in cases where the repository is accessed on a Windows platform via a drive letter mapping. the lineStart attribute.



getPromotiongroup
public String getPromotiongroup()(Code)
Get value of promotiongroup String



getPvcsbin
public String getPvcsbin()(Code)
Get name of the PVCS bin directory String



getPvcsproject
public String getPvcsproject()(Code)
Get name of the project in the PVCS repository String



getPvcsprojects
public Vector getPvcsprojects()(Code)
Get name of the project in the PVCS repository Vector



getRepository
public String getRepository()(Code)
Get network name of the PVCS repository String



getRevision
public String getRevision()(Code)
Get value of revision String



getUpdateOnly
public boolean getUpdateOnly()(Code)
get the updateOnly attribute. the updateOnly attribute.



getUserId
public String getUserId()(Code)
Get the userid. the userid.



getWorkspace
public String getWorkspace()(Code)
Get name of the workspace to store the retrieved files String



runCmd
protected int runCmd(Commandline cmd, ExecuteStreamHandler out)(Code)
Run the command.
Parameters:
  cmd - the command line to use.
Parameters:
  out - the output stream handler to use. the exit code of the command.



setConfig
public void setConfig(File f)(Code)
Sets a configuration file other than the default to be used. These files have a .cfg extension and are often found in archive or pvcsprop folders.
Parameters:
  f - config file - can be given absolute or relative to ant basedir



setFilenameFormat
public void setFilenameFormat(String f)(Code)
The format of the folder names; optional. This must be in a format suitable for java.text.MessageFormat. Index 1 of the format will be used as the file name. Defaults to {0}-arc({1})
Parameters:
  f - the format to use.



setForce
public void setForce(String f)(Code)
Specifies the value of the force argument; optional. If set to yes all files that exists and are writable are overwritten. Default no causes the files that are writable to be ignored. This stops the PVCS command get to stop asking questions!
Parameters:
  f - String (yes/no)



setIgnoreReturnCode
public void setIgnoreReturnCode(boolean b)(Code)
If set to true the return value from executing the pvcs commands are ignored; optional, default false.
Parameters:
  b - a boolean value.



setLabel
public void setLabel(String l)(Code)
Only files marked with this label are extracted; optional.
Parameters:
  l - String



setLineStart
public void setLineStart(String l)(Code)
What a valid return value from PVCS looks like when it describes a file. Defaults to "P:. If you are not using an UNC name for your repository and the drive letter P is incorrect for your setup, you may need to change this value, UNC names will always be accepted.
Parameters:
  l - the value to use.



setPromotiongroup
public void setPromotiongroup(String w)(Code)
Specifies the name of the promotiongroup argument
Parameters:
  w - String



setPvcsbin
public void setPvcsbin(String bin)(Code)
Specifies the location of the PVCS bin directory; optional if on the PATH. On some systems the PVCS executables pcli and get are not found in the PATH. In such cases this attribute should be set to the bin directory of the PVCS installation containing the executables mentioned before. If this attribute isn't specified the tag expects the executables to be found using the PATH environment variable.
Parameters:
  bin - PVCS bin directory



setPvcsproject
public void setPvcsproject(String prj)(Code)
The project within the PVCS repository to extract files from; optional, default "/"
Parameters:
  prj - String



setRepository
public void setRepository(String repo)(Code)
The network name of the PVCS repository; required.
Parameters:
  repo - String



setRevision
public void setRevision(String r)(Code)
Only files with this revision are extract; optional.
Parameters:
  r - String



setUpdateOnly
public void setUpdateOnly(boolean l)(Code)
If set to true files are fetched only if newer than existing local files; optional, default false.
Parameters:
  l - a boolean value.



setUserId
public void setUserId(String u)(Code)
User ID
Parameters:
  u - the value to use.



setWorkspace
public void setWorkspace(String ws)(Code)
Workspace to use; optional. By specifying a workspace, the files are extracted to that location. A PVCS workspace is a name for a location of the workfiles and isn't as such the location itself. You define the location for a workspace using the PVCS GUI clients. If this isn't specified the default workspace for the current user is used.
Parameters:
  ws - String



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