public class GetJobsOptions extends Options
Modifier and Type | Field and Description |
---|---|
protected boolean |
includeIntegrated
If true, include any fixes made by changelists
integrated into the specified files.
|
protected java.lang.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.
|
protected boolean |
longDescriptions
If true, return full descriptions, otherwise show
only a subset (typically the first 128 characters, but
this is not guaranteed).
|
protected int |
maxJobs
If greater than zero, limit the output to the first maxJobs jobs.
|
static java.lang.String |
OPTIONS_SPECS
Options: -e[jobview], -i, -l, -m[max], -r
|
protected boolean |
reverseOrder
If true, reverse the normal sort order.
|
immutable, optionList
Constructor and Description |
---|
GetJobsOptions()
Default constructor.
|
GetJobsOptions(int maxJobs,
boolean longDescriptions,
boolean reverseOrder,
boolean includeIntegrated,
java.lang.String jobView)
Explicit-value constructor.
|
GetJobsOptions(java.lang.String... options)
Strings-based constructor; see 'p4 help [command]' for possible options.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getJobView() |
int |
getMaxJobs() |
boolean |
isIncludeIntegrated() |
boolean |
isLongDescriptions() |
boolean |
isReverseOrder() |
java.util.List<java.lang.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.
|
GetJobsOptions |
setIncludeIntegrated(boolean includeIntegrated) |
GetJobsOptions |
setJobView(java.lang.String jobView) |
GetJobsOptions |
setLongDescriptions(boolean longDescriptions) |
GetJobsOptions |
setMaxJobs(int maxJobs) |
GetJobsOptions |
setReverseOrder(boolean reverseOrder) |
getOptions, isImmutable, processFields, setImmutable, setOptions
public static final java.lang.String OPTIONS_SPECS
protected int maxJobs
protected boolean longDescriptions
protected boolean reverseOrder
protected boolean includeIntegrated
protected java.lang.String jobView
public GetJobsOptions()
public GetJobsOptions(java.lang.String... 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.
options
- optionsOptions(java.lang.String...)
public GetJobsOptions(int maxJobs, boolean longDescriptions, boolean reverseOrder, boolean includeIntegrated, java.lang.String jobView)
maxJobs
- maxJobslongDescriptions
- longDescriptionsreverseOrder
- reverseOrderincludeIntegrated
- includeIntegratedjobView
- jobViewpublic java.util.List<java.lang.String> processOptions(IServer server) throws OptionsException
Options
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.
processOptions
in class Options
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...OptionsException
- if an error occurs in options processing that is not some
species of ConnectionException, RequestException,
AccessException, etc.Options.processOptions(com.perforce.p4java.server.IServer)
public int getMaxJobs()
public GetJobsOptions setMaxJobs(int maxJobs)
public boolean isLongDescriptions()
public GetJobsOptions setLongDescriptions(boolean longDescriptions)
public boolean isReverseOrder()
public GetJobsOptions setReverseOrder(boolean reverseOrder)
public boolean isIncludeIntegrated()
public GetJobsOptions setIncludeIntegrated(boolean includeIntegrated)
public java.lang.String getJobView()
public GetJobsOptions setJobView(java.lang.String jobView)