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


org.apache.tools.ant.Task
   org.apache.tools.ant.taskdefs.optional.perforce.P4Base

All known Subclasses:   org.apache.tools.ant.taskdefs.optional.perforce.P4Delete,  org.apache.tools.ant.taskdefs.optional.perforce.P4Resolve,  org.apache.tools.ant.taskdefs.optional.perforce.P4Revert,  org.apache.tools.ant.taskdefs.optional.perforce.P4Change,  org.apache.tools.ant.taskdefs.optional.perforce.P4Label,  org.apache.tools.ant.taskdefs.optional.perforce.P4Submit,  org.apache.tools.ant.taskdefs.optional.perforce.P4Reopen,  org.apache.tools.ant.taskdefs.optional.perforce.P4Labelsync,  org.apache.tools.ant.taskdefs.optional.perforce.P4Add,  org.apache.tools.ant.taskdefs.optional.perforce.P4Integrate,  org.apache.tools.ant.taskdefs.optional.perforce.P4Sync,  org.apache.tools.ant.taskdefs.optional.perforce.P4Edit,  org.apache.tools.ant.taskdefs.optional.perforce.P4Have,  org.apache.tools.ant.taskdefs.optional.perforce.P4Fstat,  org.apache.tools.ant.taskdefs.optional.perforce.P4Counter,
P4Base
abstract public class P4Base extends org.apache.tools.ant.Task (Code)
Base class for Perforce (P4) ANT tasks. See individual task for example usage.
See Also:   P4Sync
See Also:   P4Have
See Also:   P4Change
See Also:   P4Edit
See Also:   P4Submit
See Also:   P4Label
See Also:   org.apache.tools.ant.taskdefs.Execute


Field Summary
protected  StringP4Client
    
protected  StringP4CmdOpts
     Perforce command opts.
protected  StringP4Opts
     Perforce 'global' opts.
protected  StringP4Port
    
protected  StringP4User
    
protected  StringP4View
     Perforce view for commands.
protected  booleanfailOnError
     Keep going or fail on error - defaults to fail.
protected  Stringshell
    
protected  Perl5Utilutil
    


Method Summary
protected  voidexecP4Command(String command)
    
protected  voidexecP4Command(String command, P4Handler handler)
     Execute P4 command assembled by subclasses.
public  StringgetErrorMessage()
    
public  booleangetInError()
    
public  voidinit()
     sets attributes Port, Client, User from properties if these properties are defined.
public  voidsetClient(String p4Client)
    
public  voidsetCmdopts(String p4CmdOpts)
     Set extra command options; only used on some of the Perforce tasks.
public  voidsetErrorMessage(String errorMessage)
    
public  voidsetFailonerror(boolean fail)
    
public  voidsetGlobalopts(String p4Opts)
     Set global P4 options; Used on all of the Perforce tasks.
public  voidsetInError(boolean inError)
    
public  voidsetPort(String p4Port)
    
public  voidsetUser(String p4User)
    
public  voidsetView(String p4View)
     The client, branch or label view to operate upon; optional default "//...".

Field Detail
P4Client
protected String P4Client(Code)
Perforce Client (eg myclientspec)



P4CmdOpts
protected String P4CmdOpts(Code)
Perforce command opts. Forms half of low level API



P4Opts
protected String P4Opts(Code)
Perforce 'global' opts. Forms half of low level API



P4Port
protected String P4Port(Code)
Perforce Server Port (eg KM01:1666)



P4User
protected String P4User(Code)
Perforce User (eg fbloggs)



P4View
protected String P4View(Code)
Perforce view for commands. (eg //projects/foobar/main/source/... )



failOnError
protected boolean failOnError(Code)
Keep going or fail on error - defaults to fail.



shell
protected String shell(Code)
The OS shell to use (cmd.exe or /bin/sh)



util
protected Perl5Util util(Code)
Perl5 regexp in Java - cool eh?





Method Detail
execP4Command
protected void execP4Command(String command) throws BuildException(Code)
no usages found for this method runs a Perforce command without a handler
Parameters:
  command - the command that one wants to execute
throws:
  BuildException - if failonerror is set and the command fails



execP4Command
protected void execP4Command(String command, P4Handler handler) throws BuildException(Code)
Execute P4 command assembled by subclasses.
Parameters:
  command - The command to run
Parameters:
  handler - A P4Handler to process any input and output
throws:
  BuildException - if failonerror has been set to true



getErrorMessage
public String getErrorMessage()(Code)
gets the error message recorded by the Perforce handler error message



getInError
public boolean getInError()(Code)
gets whether or not the task has encountered an error error flag
since:
   ant 1.6



init
public void init()(Code)
sets attributes Port, Client, User from properties if these properties are defined. Called automatically by UnknownElement
See Also:   org.apache.tools.ant.UnknownElement
See Also:   
See Also:   
See Also:   
See Also:   
See Also:   
See Also:   
PropertyAttribute
p4.portPort
p4.clientClient
p4.userUser



setClient
public void setClient(String p4Client)(Code)
The p4 client spec to use; optional, defaults to the current user
Parameters:
  p4Client - the name of the Perforce client spec



setCmdopts
public void setCmdopts(String p4CmdOpts)(Code)
Set extra command options; only used on some of the Perforce tasks.
Parameters:
  p4CmdOpts - command line options going after the particularPerforce command



setErrorMessage
public void setErrorMessage(String errorMessage)(Code)
sets the error message
Parameters:
  errorMessage - line of error output



setFailonerror
public void setFailonerror(boolean fail)(Code)
whether to stop the build (true, default) or keep going if an error is returned from the p4 command
Parameters:
  fail - indicates whether one wants to fail the build if an error comes from thePerforce command



setGlobalopts
public void setGlobalopts(String p4Opts)(Code)
Set global P4 options; Used on all of the Perforce tasks.
Parameters:
  p4Opts - global options, to use a specific P4Config file for instance



setInError
public void setInError(boolean inError)(Code)
sets the error flag on the task
Parameters:
  inError - if true an error has been encountered by the handler
since:
   ant 1.6



setPort
public void setPort(String p4Port)(Code)
The p4d server and port to connect to; optional, default "perforce:1666"
Parameters:
  p4Port - the port one wants to set such as localhost:1666



setUser
public void setUser(String p4User)(Code)
The p4 username; optional, defaults to the current user
Parameters:
  p4User - the user name



setView
public void setView(String p4View)(Code)
The client, branch or label view to operate upon; optional default "//...". the view is required for the following tasks :
  • p4delete
  • p4edit
  • p4reopen
  • p4resolve

Parameters:
  p4View - the view one wants to use



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