|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.perforce.p4java.option.Options com.perforce.p4java.option.server.GetChangelistDiffsOptions
public class GetChangelistDiffsOptions
Options class for IOptionsServer.getChangelistDiffs method(s).
IOptionsServer.getChangelistDiffs(int, com.perforce.p4java.option.server.GetChangelistDiffsOptions)
Field Summary | |
---|---|
protected int |
diffContext
If positive, specifies the number of context diff lines; if zero, lets server pick context number; if negative, no options are generated. |
protected boolean |
ignoreLineEndings
If true, ignore line endings; corresponds to -dl. |
protected boolean |
ignoreWhitespace
If true, ignore whitespace; corresponds to -dw. |
protected boolean |
ignoreWhitespaceChanges
If true, ignore whitespace changes; corresponds to -db. |
static String |
OPTIONS_SPECS
Options: "-S", "-dn", "-dc[n]", "-ds", "-du[n]" "-db", "-dw", "-dl" |
protected boolean |
outputShelvedDiffs
If true, output diffs of shelved files for the changelist |
protected boolean |
rcsDiffs
If true, use RCS diff; corresponds to -dn. |
protected boolean |
summaryDiff
If true, perform summary diff; corresponds to -ds. |
protected int |
unifiedDiff
If true, do a unified diff; corresponds to -du[n] with -du generated for unifiedDiff == 0, -dun for unifiedDiff > 0, where "n" is of course the value of unifiedDiff. |
Fields inherited from class com.perforce.p4java.option.Options |
---|
immutable, optionList, OPTPFX |
Constructor Summary | |
---|---|
GetChangelistDiffsOptions()
Default constructor. |
|
GetChangelistDiffsOptions(boolean outputShelvedDiffs,
boolean rcsDiffs,
int diffContext,
boolean summaryDiff,
int unifiedDiff,
boolean ignoreWhitespaceChanges,
boolean ignoreWhitespace,
boolean ignoreLineEndings)
Explicit-value constructor. |
|
GetChangelistDiffsOptions(String... options)
Strings-based constructor; see 'p4 help [command]' for possible options. |
Method Summary | |
---|---|
int |
getDiffContext()
|
boolean |
isIgnoreLineEndings()
|
boolean |
isIgnoreWhitespace()
|
boolean |
isIgnoreWhitespaceChanges()
|
boolean |
isOutputShelvedDiffs()
|
boolean |
isRcsDiffs()
|
boolean |
isSummaryDiff()
|
int |
isUnifiedDiff()
|
List<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. |
GetChangelistDiffsOptions |
setDiffContext(int diffContext)
|
GetChangelistDiffsOptions |
setIgnoreLineEndings(boolean ignoreLineEndings)
|
GetChangelistDiffsOptions |
setIgnoreWhitespace(boolean ignoreWhitespace)
|
GetChangelistDiffsOptions |
setIgnoreWhitespaceChanges(boolean ignoreWhitespaceChanges)
|
GetChangelistDiffsOptions |
setOutputShelvedDiffs(boolean outputShelvedDiffs)
|
GetChangelistDiffsOptions |
setRcsDiffs(boolean rcsDiffs)
|
GetChangelistDiffsOptions |
setSummaryDiff(boolean summaryDiff)
|
GetChangelistDiffsOptions |
setUnifiedDiff(int unifiedDiff)
|
Methods inherited from class com.perforce.p4java.option.Options |
---|
applyRule, applyRule, applyRule, applyRule, getOptions, isImmutable, processFields, setImmutable, setOptions |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String OPTIONS_SPECS
protected boolean outputShelvedDiffs
protected boolean rcsDiffs
protected int diffContext
protected boolean summaryDiff
protected int unifiedDiff
protected boolean ignoreWhitespaceChanges
protected boolean ignoreWhitespace
protected boolean ignoreLineEndings
Constructor Detail |
---|
public GetChangelistDiffsOptions()
public GetChangelistDiffsOptions(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.Options(java.lang.String...)
public GetChangelistDiffsOptions(boolean outputShelvedDiffs, boolean rcsDiffs, int diffContext, boolean summaryDiff, int unifiedDiff, boolean ignoreWhitespaceChanges, boolean ignoreWhitespace, boolean ignoreLineEndings)
Method Detail |
---|
public List<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 isOutputShelvedDiffs()
public GetChangelistDiffsOptions setOutputShelvedDiffs(boolean outputShelvedDiffs)
public boolean isRcsDiffs()
public GetChangelistDiffsOptions setRcsDiffs(boolean rcsDiffs)
public int getDiffContext()
public GetChangelistDiffsOptions setDiffContext(int diffContext)
public boolean isSummaryDiff()
public GetChangelistDiffsOptions setSummaryDiff(boolean summaryDiff)
public int isUnifiedDiff()
public GetChangelistDiffsOptions setUnifiedDiff(int unifiedDiff)
public boolean isIgnoreWhitespaceChanges()
public GetChangelistDiffsOptions setIgnoreWhitespaceChanges(boolean ignoreWhitespaceChanges)
public boolean isIgnoreWhitespace()
public GetChangelistDiffsOptions setIgnoreWhitespace(boolean ignoreWhitespace)
public boolean isIgnoreLineEndings()
public GetChangelistDiffsOptions setIgnoreLineEndings(boolean ignoreLineEndings)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |