Package com.perforce.p4java.option.server

Class GetJobsOptions

java.lang.Object
com.perforce.p4java.option.Options
com.perforce.p4java.option.server.GetJobsOptions
public class GetJobsOptions extends Options
Options class for the IOptionsServer getJobs method.

  • Field Details

    • OPTIONS_SPECS

      public static final String OPTIONS_SPECS
      Options: -e[jobview], -i, -l, -m[max], -r
      See Also:

    • maxJobs

      protected int maxJobs
      If greater than zero, limit the output to the first maxJobs jobs. Corresponds to the -m flag.

    • longDescriptions

      protected boolean longDescriptions
      If true, return full descriptions, otherwise show only a subset (typically the first 128 characters, but this is not guaranteed). Corresponds to the -l flag.

    • reverseOrder

      protected boolean reverseOrder
      If true, reverse the normal sort order. Corresponds to the -r flag.

    • includeIntegrated

      protected boolean includeIntegrated
      If true, include any fixes made by changelists integrated into the specified files. Corresponds to the -i flag.

    • jobView

      protected String jobView
      If not null, this should be a string in format detailed by "p4 help jobview" used to restrict jobs to those satisfying the job view expression. Corresponds to the -e flag.

  • Constructor Details

    • GetJobsOptions

      public GetJobsOptions()
      Default constructor.

    • GetJobsOptions

      public GetJobsOptions(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:

    • GetJobsOptions

      public GetJobsOptions(int maxJobs, boolean longDescriptions, boolean reverseOrder, boolean includeIntegrated, String jobView)
      Explicit-value constructor.
      Parameters:
      maxJobs - maxJobs
      longDescriptions - longDescriptions
      reverseOrder - reverseOrder
      includeIntegrated - includeIntegrated
      jobView - jobView

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

    • getMaxJobs

      public int getMaxJobs()

    • setMaxJobs

      public GetJobsOptions setMaxJobs(int maxJobs)

    • isLongDescriptions

      public boolean isLongDescriptions()

    • setLongDescriptions

      public GetJobsOptions setLongDescriptions(boolean longDescriptions)

    • isReverseOrder

      public boolean isReverseOrder()

    • setReverseOrder

      public GetJobsOptions setReverseOrder(boolean reverseOrder)

    • isIncludeIntegrated

      public boolean isIncludeIntegrated()

    • setIncludeIntegrated

      public GetJobsOptions setIncludeIntegrated(boolean includeIntegrated)

    • getJobView

      public String getJobView()

    • setJobView

      public GetJobsOptions setJobView(String jobView)