public class SubmitOptions extends Options
Modifier and Type | Field and Description |
---|---|
protected java.util.List<java.lang.String> |
jobIds
If not null, should contain a list of job IDs for jobs that will have
their status changed to fixed or "jobStatus", below.
|
protected java.lang.String |
jobStatus
If not null, should contain a string to which
the jobs in the jobIds list (or local jobs list) will be set on a successful submit; if
null, the jobs will be marked "fixed".
|
static java.lang.String |
OPTIONS_SPECS
Options: -r, -s
|
protected boolean |
reOpen
If true, submitted files will remain open (on the client's
default changelist) after the submit has completed.
|
immutable, optionList
Constructor and Description |
---|
SubmitOptions()
Default constructor.
|
SubmitOptions(boolean reOpen,
java.util.List<java.lang.String> jobIds,
java.lang.String jobStatus)
Explicit value constructor.
|
SubmitOptions(java.lang.String... options)
Strings-based constructor; see 'p4 help [command]' for possible options.
|
Modifier and Type | Method and Description |
---|---|
java.util.List<java.lang.String> |
getJobIds() |
java.lang.String |
getJobStatus() |
boolean |
isReOpen() |
java.util.List<java.lang.String> |
processOptions(IServer server)
Note that the implementation of the various options here is less straightforward
than for typical server-based Options classes due to the lack of one-to-one correspondence
between options and flags and the need for strict option ordering.
|
SubmitOptions |
setJobIds(java.util.List<java.lang.String> jobIds) |
SubmitOptions |
setJobStatus(java.lang.String jobStatus) |
SubmitOptions |
setReOpen(boolean reOpen) |
getOptions, isImmutable, processFields, setImmutable, setOptions
public static final java.lang.String OPTIONS_SPECS
protected boolean reOpen
protected java.util.List<java.lang.String> jobIds
This list will override any jobs already in the changelist's local job list (usually the result of being fixed elsewhere and picked up during a refresh of the changelist).
protected java.lang.String jobStatus
public SubmitOptions()
public SubmitOptions(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 SubmitOptions(boolean reOpen, java.util.List<java.lang.String> jobIds, java.lang.String jobStatus)
reOpen
- true/falsejobIds
- jobIDjobStatus
- statuspublic java.util.List<java.lang.String> processOptions(IServer server) throws OptionsException
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 boolean isReOpen()
public SubmitOptions setReOpen(boolean reOpen)
public java.util.List<java.lang.String> getJobIds()
public SubmitOptions setJobIds(java.util.List<java.lang.String> jobIds)
public java.lang.String getJobStatus()
public SubmitOptions setJobStatus(java.lang.String jobStatus)