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

Class P4Base

public abstract class P4Base extends Task

Base class for Perforce (P4) ANT tasks. See individual task for example usage.

See Also: P4Sync P4Have P4Change P4Edit P4Submit P4Label Execute

Field Summary
protected booleanfailOnError
Keep going or fail on error - defaults to fail.
protected StringP4Client
Perforce Client (eg myclientspec)
protected StringP4CmdOpts
Perforce command opts.
protected StringP4Opts
Perforce 'global' opts.
protected StringP4Port
Perforce Server Port (eg KM01:1666)
protected StringP4User
Perforce User (eg fbloggs)
protected StringP4View
Perforce view for commands. (eg //projects/foobar/main/source/...
protected Stringshell
The OS shell to use (cmd.exe or /bin/sh)
protected Perl5Utilutil
Perl5 regexp in Java - cool eh?
Method Summary
protected voidexecP4Command(String command)
no usages found for this method runs a Perforce command without a handler
protected voidexecP4Command(String command, P4Handler handler)
Execute P4 command assembled by subclasses.
StringgetErrorMessage()
gets the error message recorded by the Perforce handler
booleangetInError()
gets whether or not the task has encountered an error
voidinit()
sets attributes Port, Client, User from properties if these properties are defined.
voidsetClient(String P4Client)
The p4 client spec to use; optional, defaults to the current user
voidsetCmdopts(String P4CmdOpts)
Set extra command options; only used on some of the Perforce tasks.
voidsetErrorMessage(String errorMessage)
sets the error message
voidsetFailonerror(boolean fail)
whether to stop the build (true, default) or keep going if an error is returned from the p4 command
voidsetGlobalopts(String P4Opts)
Set global P4 options; Used on all of the Perforce tasks.
voidsetInError(boolean inError)
sets the error flag on the task
voidsetPort(String P4Port)
The p4d server and port to connect to; optional, default "perforce:1666"
voidsetUser(String P4User)
The p4 username; optional, defaults to the current user
voidsetView(String P4View)
The client, branch or label view to operate upon; optional default "//...". the view is required for the following tasks :
  • p4delete
  • p4edit
  • p4reopen
  • p4resolve

Field Detail

failOnError

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

P4Client

protected String P4Client
Perforce Client (eg myclientspec)

P4CmdOpts

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

P4Opts

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

P4Port

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

P4User

protected String P4User
Perforce User (eg fbloggs)

P4View

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

shell

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

util

protected Perl5Util util
Perl5 regexp in Java - cool eh?

Method Detail

execP4Command

protected void execP4Command(String command)
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)
Execute P4 command assembled by subclasses.

Parameters: command The command to run handler A P4Handler to process any input and output

Throws: BuildException if failonerror has been set to true

getErrorMessage

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

Returns: error message

getInError

public boolean getInError()
gets whether or not the task has encountered an error

Returns: error flag

Since: ant 1.6

init

public void init()
sets attributes Port, Client, User from properties if these properties are defined. Called automatically by UnknownElement

See Also:

PropertyAttribute
p4.portPort
p4.clientClient
p4.userUser

setClient

public void setClient(String P4Client)
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)
Set extra command options; only used on some of the Perforce tasks.

Parameters: P4CmdOpts command line options going after the particular Perforce command

setErrorMessage

public void setErrorMessage(String errorMessage)
sets the error message

Parameters: errorMessage line of error output

setFailonerror

public void setFailonerror(boolean fail)
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 the Perforce command

setGlobalopts

public void setGlobalopts(String P4Opts)
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)
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)
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)
The p4 username; optional, defaults to the current user

Parameters: P4User the user name

setView

public void setView(String P4View)
The client, branch or label view to operate upon; optional default "//...". the view is required for the following tasks :

Parameters: P4View the view one wants to use

Copyright