public class GetInterchangesOptions extends Options
Modifier and Type | Field and Description |
---|---|
protected boolean |
biDirectional
If true, causes the branch view to work
bidirectionally, where the scope of the command is limited to
integrations whose 'from' files match fromFile[revRange].
|
protected java.lang.String |
branch
If non-null, use a user-defined branch view.
|
protected boolean |
longDesc
If true, produce long output with the full text of the
changelist descriptions.
|
protected int |
maxChangelistId
If greater than zero, only consider integration history from changelists
at or below the given number.
|
static java.lang.String |
OPTIONS_SPECS
Options: -f, -l, -C[changelist], -b[branch], -S[stream], -P[parentStream], -r, -s
|
protected java.lang.String |
parentStream
If non-null, specify a parent stream other than the stream's actual
parent.
|
protected boolean |
reverseMapping
If true, reverse the mappings in the branch view, with the
target files and source files exchanging place.
|
protected boolean |
showFiles
If true, show the individual files that would require integration.
|
protected java.lang.String |
stream
If not null, makes 'p4 interchanges' use a stream's branch view.
|
immutable, optionList
Constructor and Description |
---|
GetInterchangesOptions()
Default constructor.
|
GetInterchangesOptions(boolean showFiles,
boolean longDesc,
int maxChangelistId,
boolean reverseMapping,
boolean biDirectional)
Explicit-value constructor.
|
GetInterchangesOptions(boolean showFiles,
boolean longDesc,
int maxChangelistId,
java.lang.String branch,
boolean reverseMapping,
boolean biDirectional)
Explicit-value constructor for use with a branch.
|
GetInterchangesOptions(boolean showFiles,
boolean longDesc,
int maxChangelistId,
java.lang.String stream,
java.lang.String parentStream,
boolean reverseMapping,
boolean biDirectional)
Explicit-value constructor for use with a stream.
|
GetInterchangesOptions(java.lang.String... options)
Strings-based constructor; see 'p4 help [command]' for possible options.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getBranch() |
int |
getMaxChangelistId() |
java.lang.String |
getParentStream() |
java.lang.String |
getStream() |
boolean |
isBiDirectional() |
boolean |
isLongDesc() |
boolean |
isReverseMapping() |
boolean |
isShowFiles() |
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.
|
GetInterchangesOptions |
setBiDirectional(boolean biDirectional) |
GetInterchangesOptions |
setBranch(java.lang.String branch) |
GetInterchangesOptions |
setLongDesc(boolean longDesc) |
GetInterchangesOptions |
setMaxChangelistId(int maxChangelistId) |
GetInterchangesOptions |
setParentStream(java.lang.String parentStream) |
GetInterchangesOptions |
setReverseMapping(boolean reverseMapping) |
GetInterchangesOptions |
setShowFiles(boolean showFiles) |
GetInterchangesOptions |
setStream(java.lang.String stream) |
getOptions, isImmutable, processFields, setImmutable, setOptions
public static final java.lang.String OPTIONS_SPECS
NOTE: not all options will be recognized by the specific version of the getInterchanges method being called.
protected boolean showFiles
protected boolean longDesc
protected int maxChangelistId
protected boolean reverseMapping
protected boolean biDirectional
protected java.lang.String branch
protected java.lang.String stream
protected java.lang.String parentStream
public GetInterchangesOptions()
public GetInterchangesOptions(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 GetInterchangesOptions(boolean showFiles, boolean longDesc, int maxChangelistId, boolean reverseMapping, boolean biDirectional)
showFiles
- showFileslongDesc
- longDescmaxChangelistId
- maxChangelistIdreverseMapping
- reverseMappingbiDirectional
- biDirectionalpublic GetInterchangesOptions(boolean showFiles, boolean longDesc, int maxChangelistId, java.lang.String branch, boolean reverseMapping, boolean biDirectional)
showFiles
- showFileslongDesc
- longDescmaxChangelistId
- maxChangelistIdbranch
- branchreverseMapping
- reverseMappingbiDirectional
- biDirectionalpublic GetInterchangesOptions(boolean showFiles, boolean longDesc, int maxChangelistId, java.lang.String stream, java.lang.String parentStream, boolean reverseMapping, boolean biDirectional)
showFiles
- showFileslongDesc
- longDescmaxChangelistId
- maxChangelistIdstream
- streamparentStream
- parentStreamreverseMapping
- reverseMappingbiDirectional
- biDirectionalpublic 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 boolean isShowFiles()
public GetInterchangesOptions setShowFiles(boolean showFiles)
public boolean isLongDesc()
public GetInterchangesOptions setLongDesc(boolean longDesc)
public int getMaxChangelistId()
public GetInterchangesOptions setMaxChangelistId(int maxChangelistId)
public boolean isReverseMapping()
public GetInterchangesOptions setReverseMapping(boolean reverseMapping)
public boolean isBiDirectional()
public GetInterchangesOptions setBiDirectional(boolean biDirectional)
public java.lang.String getBranch()
public GetInterchangesOptions setBranch(java.lang.String branch)
public java.lang.String getStream()
public GetInterchangesOptions setStream(java.lang.String stream)
public java.lang.String getParentStream()
public GetInterchangesOptions setParentStream(java.lang.String parentStream)