Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.perforce.p4java.option.client
Class DeleteFilesOptions

java.lang.Object
  extended by com.perforce.p4java.option.Options
      extended by com.perforce.p4java.option.client.DeleteFilesOptions

public class DeleteFilesOptions
extends Options

Options-based method options for IClient deleteFiles method(s).

See Also:
IClient.deleteFiles(java.util.List, com.perforce.p4java.option.client.DeleteFilesOptions)

Field Summary
protected  boolean bypassClientDelete
          If true, bypass deleting files on the client workspace.
protected  int changelistId
          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.
static String OPTIONS_SPECS
          Options: -c[changelist], -n, -v, -k
 
Fields inherited from class com.perforce.p4java.option.Options
immutable, optionList, OPTPFX
 
Constructor Summary
DeleteFilesOptions()
          Default constructor.
DeleteFilesOptions(int changelistId, boolean noUpdate, boolean deleteNonSyncedFiles)
          Explicit-value constructor.
DeleteFilesOptions(int changelistId, boolean noUpdate, boolean deleteNonSyncedFiles, boolean bypassClientDelete)
          Explicit-value constructor.
DeleteFilesOptions(String... options)
          Strings-based constructor; see 'p4 help [command]' for possible options.
 
Method Summary
 int getChangelistId()
           
 boolean isBypassClientDelete()
           
 boolean isDeleteNonSyncedFiles()
           
 boolean isNoUpdate()
           
 List<String> processOptions(IServer server)
          Turn this (specific) options object into a list of strings to be sent to the Perforce server as options for a specific command.
 DeleteFilesOptions setBypassClientDelete(boolean bypassClientDelete)
           
 DeleteFilesOptions setChangelistId(int changelistId)
           
 DeleteFilesOptions setDeleteNonSyncedFiles(boolean deleteNonSyncedFiles)
           
 DeleteFilesOptions setNoUpdate(boolean noUpdate)
           
 
Methods inherited from class com.perforce.p4java.option.Options
applyRule, applyRule, applyRule, applyRule, getOptions, isImmutable, processFields, setImmutable, setOptions
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

OPTIONS_SPECS

public static final String OPTIONS_SPECS
Options: -c[changelist], -n, -v, -k

See Also:
Constant Field Values

changelistId

protected int changelistId
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. Corresponds to the -c flag.

noUpdate

protected boolean noUpdate
If true, don't actually do the deletes, just return the files that would have been opened for deletion. Corresponds to the -n flag.

deleteNonSyncedFiles

protected boolean deleteNonSyncedFiles
If true, delete files that are not synced into the client workspace. Corresponds to the -v flag.

bypassClientDelete

protected boolean bypassClientDelete
If true, bypass deleting files on the client workspace. The -k flag performs the delete on the server without modifying client files. Use with caution, as an incorrect delete can cause discrepancies between the state of the client and the corresponding server metadata. Corresponds to the -k flag.

Constructor Detail

DeleteFilesOptions

public DeleteFilesOptions()
Default constructor.

DeleteFilesOptions

public DeleteFilesOptions(String... options)
Strings-based constructor; see 'p4 help [command]' for possible options.

WARNING: you should not pass more than one option or argument in each string parameter. Each option or argument should be passed-in as its own separate string parameter, without any spaces between the option and the option value (if any).

NOTE: setting options this way always bypasses the internal options values, and getter methods against the individual values corresponding to the strings passed in to this constructor will not normally reflect the string's setting. Do not use this constructor unless you know what you're doing and / or you do not also use the field getters and setters.

See Also:
Options.Options(java.lang.String...)

DeleteFilesOptions

public DeleteFilesOptions(int changelistId,
                          boolean noUpdate,
                          boolean deleteNonSyncedFiles)
Explicit-value constructor.

DeleteFilesOptions

public DeleteFilesOptions(int changelistId,
                          boolean noUpdate,
                          boolean deleteNonSyncedFiles,
                          boolean bypassClientDelete)
Explicit-value constructor.

Method Detail

processOptions

public List<String> processOptions(IServer server)
                            throws OptionsException
Description copied from class: Options
Turn this (specific) options object into a list of strings to be sent to the Perforce server as options for a specific command. As a side effect, set the option list associated with this Option to the result.

The method is used by the server object to generate the string-based arguments expected by the Perforce server corresponding to the state of this method-specific options object. Will return an empty list if there are no "interesting" options set or available. May simply return the superclass options string list if is non-null, but that behaviour is neither guaranteed nor required.

Note that this method is not intended to be called directly by users but by the underlying P4Java plumbing; odd results may occur if this method is called in other contexts.

Specified by:
processOptions in class Options
Parameters:
server - possibly-null IServer representing the Perforce server the options are to be used against. If this parameter is null, it is acceptable to throw an OptionsException, but it is also possible to ignore it and do the best you can with what you've got...
Returns:
non-null (but possibly empty) string list representing the normalized Perforce server arguments corresponding to the state of this specific options object.
Throws:
OptionsException - if an error occurs in options processing that is not some species of ConnectionException, RequestException, AccessException, etc.
See Also:
Options.processOptions(com.perforce.p4java.server.IServer)

getChangelistId

public int getChangelistId()

setChangelistId

public DeleteFilesOptions setChangelistId(int changelistId)

isNoUpdate

public boolean isNoUpdate()

setNoUpdate

public DeleteFilesOptions setNoUpdate(boolean noUpdate)

isDeleteNonSyncedFiles

public boolean isDeleteNonSyncedFiles()

setDeleteNonSyncedFiles

public DeleteFilesOptions setDeleteNonSyncedFiles(boolean deleteNonSyncedFiles)

isBypassClientDelete

public boolean isBypassClientDelete()

setBypassClientDelete

public DeleteFilesOptions setBypassClientDelete(boolean bypassClientDelete)
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2015 Perforce Software. All Rights Reserved.