|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.tools.ant.ProjectComponent org.apache.tools.ant.Task org.apache.tools.ant.taskdefs.optional.perforce.P4Base
public abstract class P4Base
Base class for Perforce (P4) ANT tasks. See individual task for example usage.
P4Sync
,
P4Have
,
P4Change
,
P4Edit
,
P4Submit
,
P4Label
,
Execute
Field Summary | |
---|---|
protected boolean |
failOnError
Keep going or fail on error - defaults to fail. |
protected java.lang.String |
P4Client
Perforce Client (eg myclientspec) |
protected java.lang.String |
P4CmdOpts
Perforce command opts. |
protected java.lang.String |
P4Opts
Perforce 'global' opts. |
protected java.lang.String |
P4Port
Perforce Server Port (eg KM01:1666) |
protected java.lang.String |
P4User
Perforce User (eg fbloggs) |
protected java.lang.String |
P4View
Perforce view for commands. |
protected java.lang.String |
shell
The OS shell to use (cmd.exe or /bin/sh) |
protected org.apache.oro.text.perl.Perl5Util |
util
Perl5 regexp in Java - cool eh? |
Fields inherited from class org.apache.tools.ant.Task |
---|
target, taskName, taskType, wrapper |
Fields inherited from class org.apache.tools.ant.ProjectComponent |
---|
description, location, project |
Constructor Summary | |
---|---|
P4Base()
|
Method Summary | |
---|---|
protected void |
execP4Command(java.lang.String command)
no usages found for this method runs a Perforce command without a handler |
protected void |
execP4Command(java.lang.String command,
P4Handler handler)
Execute P4 command assembled by subclasses. |
java.lang.String |
getErrorMessage()
gets the error message recorded by the Perforce handler |
boolean |
getInError()
gets whether or not the task has encountered an error |
void |
init()
sets attributes Port, Client, User from properties if these properties are defined. |
void |
setClient(java.lang.String p4Client)
The p4 client spec to use; optional, defaults to the current user |
void |
setCmdopts(java.lang.String p4CmdOpts)
Set extra command options; only used on some of the Perforce tasks. |
void |
setErrorMessage(java.lang.String errorMessage)
sets the error message |
void |
setFailonerror(boolean fail)
whether to stop the build (true, default) or keep going if an error is returned from the p4 command |
void |
setGlobalopts(java.lang.String p4Opts)
Set global P4 options; Used on all of the Perforce tasks. |
void |
setInError(boolean inError)
sets the error flag on the task |
void |
setPort(java.lang.String p4Port)
The p4d server and port to connect to; optional, default "perforce:1666" |
void |
setUser(java.lang.String p4User)
The p4 username; optional, defaults to the current user |
void |
setView(java.lang.String p4View)
The client, branch or label view to operate upon; optional default "//...". |
Methods inherited from class org.apache.tools.ant.Task |
---|
bindToOwner, execute, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType |
Methods inherited from class org.apache.tools.ant.ProjectComponent |
---|
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected org.apache.oro.text.perl.Perl5Util util
protected java.lang.String shell
protected java.lang.String P4Port
protected java.lang.String P4Client
protected java.lang.String P4User
protected java.lang.String P4View
protected boolean failOnError
protected java.lang.String P4Opts
protected java.lang.String P4CmdOpts
Constructor Detail |
---|
public P4Base()
Method Detail |
---|
public boolean getInError()
public void setInError(boolean inError)
inError
- if true an error has been encountered by the handlerpublic java.lang.String getErrorMessage()
public void setErrorMessage(java.lang.String errorMessage)
errorMessage
- line of error outputpublic void setPort(java.lang.String p4Port)
p4Port
- the port one wants to set such as localhost:1666public void setClient(java.lang.String p4Client)
p4Client
- the name of the Perforce client specpublic void setUser(java.lang.String p4User)
p4User
- the user namepublic void setGlobalopts(java.lang.String p4Opts)
p4Opts
- global options, to use a specific P4Config file for instancepublic void setView(java.lang.String p4View)
p4View
- the view one wants to usepublic void setCmdopts(java.lang.String p4CmdOpts)
p4CmdOpts
- command line options going after the particular
Perforce commandpublic void setFailonerror(boolean fail)
fail
- indicates whether one wants to fail the build if an error comes from the
Perforce commandpublic void init()
init
in class Task
Property Attribute
p4.port Port
p4.client Client
p4.user User
protected void execP4Command(java.lang.String command) throws BuildException
command
- the command that one wants to execute
BuildException
- if failonerror is set and the command failsprotected void execP4Command(java.lang.String command, P4Handler handler) throws BuildException
command
- The command to runhandler
- A P4Handler to process any input and output
BuildException
- if failonerror has been set to true
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |