public class DescribeOptions extends Options
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
OPTIONS_SPECS
Options:
|
immutable, optionList
Constructor and Description |
---|
DescribeOptions()
Default constructor.
|
DescribeOptions(DiffType type)
Create a changelist describe options
|
DescribeOptions(DiffType type,
boolean outputShelvedDiffs)
Create a changelist describe options
|
DescribeOptions(java.lang.String... options)
Strings-based constructor; see 'p4 help [command]' for possible options.
|
Modifier and Type | Method and Description |
---|---|
DiffType |
getType() |
boolean |
isOutputShelvedDiffs() |
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.
|
DescribeOptions |
setOutputShelvedDiffs(boolean showShelvedDiffs) |
DescribeOptions |
setType(DiffType type) |
getOptions, isImmutable, processFields, setImmutable, setOptions
public DescribeOptions()
public DescribeOptions(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 DescribeOptions(DiffType type)
type
- diff typepublic DescribeOptions(DiffType type, boolean outputShelvedDiffs)
type
- diff typeoutputShelvedDiffs
- shelved diffs optionpublic DiffType getType()
public DescribeOptions setType(DiffType type)
type
- the type to setpublic boolean isOutputShelvedDiffs()
public DescribeOptions setOutputShelvedDiffs(boolean showShelvedDiffs)
showShelvedDiffs
- the showShelvedDiffs to setpublic 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)