public class GetRevisionHistoryOptions extends Options
Note that behavior is undefined if both longOutput and truncatedLongOutput are true. If both are false, a short form of the description (prepared by the server) is returned.
Modifier and Type | Field and Description |
---|---|
protected int |
changelistId
If positive, displays only files submitted at the given changelist number.
|
protected boolean |
contentHistory
If true, display file content history instead of file name history.
|
protected boolean |
includeInherited
If true, causes inherited file history to be displayed as well.
|
protected boolean |
longOutput
If true, produces long output with the full text of the
changelist descriptions.
|
protected int |
maxRevs
If positive, displays at most 'maxRevs' revisions per file of
the file[rev] argument specified.
|
protected boolean |
omitNonContributaryIntegrations
If true, omit non-contributory integrations;
corresponds to -s.
|
static java.lang.String |
OPTIONS_SPECS
Options: -c[changelist], -m[max], -h, -i, -l, -L, -s
|
protected boolean |
truncatedLongOutput
If true, produces long output with the full text of the
changelist descriptions truncated to 250 characters.
|
immutable, optionList
Constructor and Description |
---|
GetRevisionHistoryOptions()
Default constructor.
|
GetRevisionHistoryOptions(int changelistId,
int maxRevs,
boolean contentHistory,
boolean includeInherited,
boolean longOutput,
boolean truncatedLongOutput)
Explicit-value constructor.
|
GetRevisionHistoryOptions(int changelistId,
int maxRevs,
boolean contentHistory,
boolean includeInherited,
boolean longOutput,
boolean truncatedLongOutput,
boolean omitNonContributaryIntegrations)
Explicit-value constructor.
|
GetRevisionHistoryOptions(java.lang.String... options)
Strings-based constructor; see 'p4 help [command]' for possible options.
|
Modifier and Type | Method and Description |
---|---|
int |
getChangelistId() |
int |
getMaxRevs() |
boolean |
isContentHistory() |
boolean |
isIncludeInherited() |
boolean |
isLongOutput() |
boolean |
isOmitNonContributaryIntegrations() |
boolean |
isTruncatedLongOutput() |
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.
|
GetRevisionHistoryOptions |
setChangelistId(int changelistId) |
GetRevisionHistoryOptions |
setContentHistory(boolean contentHistory) |
GetRevisionHistoryOptions |
setIncludeInherited(boolean includeInherited) |
GetRevisionHistoryOptions |
setLongOutput(boolean longOutput) |
GetRevisionHistoryOptions |
setMaxRevs(int maxRevs) |
GetRevisionHistoryOptions |
setOmitNonContributaryIntegrations(boolean omitNonContributaryIntegrations) |
GetRevisionHistoryOptions |
setTruncatedLongOutput(boolean truncatedLongOutput) |
getOptions, isImmutable, processFields, setImmutable, setOptions
public static final java.lang.String OPTIONS_SPECS
protected int changelistId
protected int maxRevs
protected boolean contentHistory
protected boolean includeInherited
protected boolean longOutput
protected boolean truncatedLongOutput
protected boolean omitNonContributaryIntegrations
public GetRevisionHistoryOptions()
public GetRevisionHistoryOptions(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 GetRevisionHistoryOptions(int changelistId, int maxRevs, boolean contentHistory, boolean includeInherited, boolean longOutput, boolean truncatedLongOutput)
changelistId
- changelistIdmaxRevs
- maxRevscontentHistory
- contentHistoryincludeInherited
- includeInheritedlongOutput
- longOutputtruncatedLongOutput
- truncatedLongOutputpublic GetRevisionHistoryOptions(int changelistId, int maxRevs, boolean contentHistory, boolean includeInherited, boolean longOutput, boolean truncatedLongOutput, boolean omitNonContributaryIntegrations)
changelistId
- changelistIdmaxRevs
- maxRevscontentHistory
- contentHistoryincludeInherited
- includeInheritedlongOutput
- longOutputtruncatedLongOutput
- truncatedLongOutputomitNonContributaryIntegrations
- omitNonContributaryIntegrationspublic 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 getChangelistId()
public GetRevisionHistoryOptions setChangelistId(int changelistId)
public int getMaxRevs()
public GetRevisionHistoryOptions setMaxRevs(int maxRevs)
public boolean isContentHistory()
public GetRevisionHistoryOptions setContentHistory(boolean contentHistory)
public boolean isIncludeInherited()
public GetRevisionHistoryOptions setIncludeInherited(boolean includeInherited)
public boolean isLongOutput()
public GetRevisionHistoryOptions setLongOutput(boolean longOutput)
public boolean isTruncatedLongOutput()
public GetRevisionHistoryOptions setTruncatedLongOutput(boolean truncatedLongOutput)
public boolean isOmitNonContributaryIntegrations()
public GetRevisionHistoryOptions setOmitNonContributaryIntegrations(boolean omitNonContributaryIntegrations)
omitNonContributaryIntegrations
- option