com.perforce.p4java.ant.tasks
Class DeleteTask

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.DeleteTask

All Implemented Interfaces:

java.lang.Cloneable

public class DeleteTask
extends ClientTask

Opens a file that currently exists in the depot for deletion. If the file is present on the client it is removed. If a pending changelist number is given the opened file is associated with that changelist, otherwise it is associated with the 'default' pending changelist.

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 java.lang.String	changelist If positive, the deleted files are put into the pending changelist identified by changelistId (this changelist must have been previously created for this to succeed).
protected boolean	deleteNonSyncedFiles If true, delete files that are not synced into the client workspace.
protected boolean	noUpdate If true, don't actually do the deletes, just return the files that would have been opened for deletion.

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

DeleteTask()
Default constructor.

Method Summary

protected void	execP4Command() Execute the Perforce delete command with file specs and options.
void	setChangelist(java.lang.String changelist) Sets the changelist.
void	setDeleteNonSyncedFiles(boolean deleteNonSyncedFiles) Sets the delete non synced files.
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

changelist

protected java.lang.String changelist

If positive, the deleted 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.

noUpdate

protected boolean noUpdate

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

deleteNonSyncedFiles

protected boolean deleteNonSyncedFiles

If true, delete files that are not synced into the client workspace.

Constructor Detail

DeleteTask

public DeleteTask()

Default constructor.

Method Detail

setNoUpdate

public void setNoUpdate(boolean noUpdate)

Sets the no update.

Parameters:

noUpdate - the new no update

setDeleteNonSyncedFiles

public void setDeleteNonSyncedFiles(boolean deleteNonSyncedFiles)

Sets the delete non synced files.

Parameters:

deleteNonSyncedFiles - the new delete non synced files

setChangelist

public void setChangelist(java.lang.String changelist)

Sets the changelist.

Parameters:

changelist - the new changelist

execP4Command

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

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

Open Perforce client workspace files for deletion from a Perforce depot.

Specified by:

execP4Command in class PerforceTask

Throws:

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

See Also:

PerforceTask.execP4Command()