Package com.perforce.p4java.option.client

Class DeleteFilesOptions

java.lang.Object
com.perforce.p4java.option.Options
com.perforce.p4java.option.client.DeleteFilesOptions
public class DeleteFilesOptions extends Options
Options-based method options for IClient deleteFiles method(s).
See Also:

  • Field Details

    • OPTIONS_SPECS

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

    • 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 Details

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

      Parameters:
      options - options
      See Also:

    • DeleteFilesOptions

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

    • DeleteFilesOptions

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

  • Method Details

    • 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:

    • 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)