com.perforce.p4java.ant.tasks
Class EditTask

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          com.perforce.p4java.ant.tasks.PerforceTask
              com.perforce.p4java.ant.tasks.ServerTask
                  com.perforce.p4java.ant.tasks.ClientTask
                      com.perforce.p4java.ant.tasks.EditTask

All Implemented Interfaces:

java.lang.Cloneable

public class EditTask
extends ClientTask

Open an existing file for edit. The server notes that the current user on the current client has the file opened, and then changes the file permission from read-only to read/write.

See Also:

PerforceTask, ClientTask

Nested Class Summary

Nested classes/interfaces inherited from class com.perforce.p4java.ant.tasks.ServerTask

ServerTask.GlobalOption

Nested classes/interfaces inherited from class com.perforce.p4java.ant.tasks.PerforceTask

PerforceTask.Field, PerforceTask.File

Field Summary

protected boolean	bypassClientUpdate If true, bypass updating the client.
protected java.lang.String	changelist If positive, the opened files are put into the pending changelist identified by changelistId (this changelist must have been previously created for this to succeed).
protected java.lang.String	fileType If non-null, the files are added as that filetype.
protected boolean	noUpdate If true, don't actually do the edit, just return the files that would have been opened for edit.

Fields inherited from class com.perforce.p4java.ant.tasks.ClientTask

p4Client

Fields inherited from class com.perforce.p4java.ant.tasks.ServerTask

allHosts, commandOptions, globaloptions, hostName, P4_SERVER_PROTOCOL_PROPERTIES_FILE, P4_SERVER_USAGE_PROPERTIES_FILE, p4Server, programName, programVersion, protocolPropertiesFile, protocolProps, textLanguage, unsetClientName, unsetUserName, usagePropertiesFile, usageProps, workingDirectory

Fields inherited from class com.perforce.p4java.ant.tasks.PerforceTask

charset, client, failOnError, fields, FILE_TOKEN_REGEX_PATTERN, fileList, files, fileSpecs, LINE_PADDING, LINE_SEPARATOR, p4Messages, passwd, port, protocol, retFileSpecs, retStatusMessage, user

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

EditTask()
Default constructor.

Method Summary

protected void	execP4Command() Execute the Perforce edit command with file specs and options.
void	setBypassClientUpdate(boolean bypassClientUpdate) Sets the bypass client update.
void	setChangelist(java.lang.String changelist) Sets the changelist.
void	setFileType(java.lang.String fileType) Sets the file type.
void	setNoUpdate(boolean noUpdate) Sets the no update.

Methods inherited from class com.perforce.p4java.ant.tasks.ClientTask

cleanupP4, getP4Client, initP4, setP4Client

Methods inherited from class com.perforce.p4java.ant.tasks.ServerTask

cleanupP4Server, createGlobalOption, getGlobalOptions, getP4Server, initP4Server, initP4ServerOptions, setAllHosts, setHostName, setP4Server, setProgramName, setProgramVersion, setProtocolPropertiesFile, setProtocolProps, setTextLanguage, setUnsetClientName, setUnsetUserName, setUsagePropertiesFile, setUsageProps, setWorkingDirectory

Methods inherited from class com.perforce.p4java.ant.tasks.PerforceTask

addFileset, createField, createFile, execute, getFields, getFiles, getFileSpecs, getRetFileSpecs, getRetStatusMessage, init, isEmpty, logChangelistSummaries, logChangelistSummary, logExtendedFileSpec, logExtendedFileSpecs, logFileDiff, logFileDiffs, logFileLineMatch, logFileLineMatches, logFileSpec, logFileSpecs, logFix, logFixes, logJob, logJobs, parseChangelist, setCharset, setClient, setFailOnError, setFiles, setPasswd, setPort, setProtocol, setUser

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, 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

noUpdate

protected boolean noUpdate

If true, don't actually do the edit, just return the files that would have been opened for edit.

bypassClientUpdate

protected boolean bypassClientUpdate

If true, bypass updating the client.

changelist

protected java.lang.String changelist

If positive, the opened files are put into the pending changelist identified by changelistId (this changelist must have been previously created for this to succeed). If zero or negative, the file is opened in the 'default' (unnumbered) changelist.

fileType

protected java.lang.String fileType

If non-null, the files are added as that filetype. See 'p4 help filetypes' to attempt to make any sense of Perforce file types.

Constructor Detail

EditTask

public EditTask()

Default constructor.

Method Detail

setNoUpdate

public void setNoUpdate(boolean noUpdate)

Sets the no update.

Parameters:

noUpdate - the new no update

setBypassClientUpdate

public void setBypassClientUpdate(boolean bypassClientUpdate)

Sets the bypass client update.

Parameters:

bypassClientUpdate - the new bypass client update

setChangelist

public void setChangelist(java.lang.String changelist)

Sets the changelist.

Parameters:

changelist - the new changelist

setFileType

public void setFileType(java.lang.String fileType)

Sets the file type.

Parameters:

fileType - the new file type

execP4Command

protected void execP4Command()
                      throws org.apache.tools.ant.BuildException

Execute the Perforce edit command with file specs and options. Log the returned file specs.

Open one or more Perforce client workspace files for editing.

Specified by:

execP4Command in class PerforceTask

Throws:

org.apache.tools.ant.BuildException - the build exception

See Also:

PerforceTask.execP4Command()