Package com.perforce.p4java.option.server

Class GetChangelistDiffsOptions

java.lang.Object

com.perforce.p4java.option.Options

com.perforce.p4java.option.server.GetChangelistDiffsOptions

All Implemented Interfaces:

DiffsOptions<GetChangelistDiffsOptions>

public class GetChangelistDiffsOptions
extends Options
implements DiffsOptions<GetChangelistDiffsOptions>

Options class for IOptionsServer.getChangelistDiffs method(s).

See Also:

IDescribeDelegator.getChangelistDiffs(int, com.perforce.p4java.option.server.GetChangelistDiffsOptions)

Field Summary

Fields

Modifier and Type	Field	Description
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 java.lang.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

Constructor Summary

Constructors

Constructor	Description
GetChangelistDiffsOptions()	Default constructor.
GetChangelistDiffsOptions(boolean outputShelvedDiffs, boolean rcsDiffs, int diffContext, boolean summaryDiff, int unifiedDiff, boolean ignoreWhitespaceChanges, boolean ignoreWhitespace, boolean ignoreLineEndings)	Explicit-value constructor.
GetChangelistDiffsOptions(java.lang.String... options)	Strings-based constructor; see 'p4 help [command]' for possible options.

Method Summary

Modifier and Type	Method	Description
int	getDiffContext()
boolean	isIgnoreLineEndings()
boolean	isIgnoreWhitespace()
boolean	isIgnoreWhitespaceChanges()
boolean	isOutputShelvedDiffs()
boolean	isRcsDiffs()
boolean	isSummaryDiff()
int	isUnifiedDiff()
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.
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

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

OPTIONS_SPECS

public static final java.lang.String OPTIONS_SPECS

Options: "-S", "-dn", "-dc[n]", "-ds", "-du[n]" "-db", "-dw", "-dl"

See Also:

Constant Field Values

outputShelvedDiffs

protected boolean outputShelvedDiffs

If true, output diffs of shelved files for the changelist

rcsDiffs

protected boolean rcsDiffs

If true, use RCS diff; corresponds to -dn.

diffContext

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. Corresponds to -dc[n], with -dc generated for diffContext == 0, -dcn for diffContext > 0, where "n" is of course the value of diffContext.

summaryDiff

protected boolean summaryDiff

If true, perform summary diff; corresponds to -ds.

unifiedDiff

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.

ignoreWhitespaceChanges

protected boolean ignoreWhitespaceChanges

If true, ignore whitespace changes; corresponds to -db.

ignoreWhitespace

protected boolean ignoreWhitespace

If true, ignore whitespace; corresponds to -dw.

ignoreLineEndings

protected boolean ignoreLineEndings

If true, ignore line endings; corresponds to -dl.

Constructor Detail

GetChangelistDiffsOptions

public GetChangelistDiffsOptions()

Default constructor.

GetChangelistDiffsOptions

public GetChangelistDiffsOptions(java.lang.String... options)

Strings-based constructor; see 'p4 help [command]' for possible 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.

Parameters:

options - options

See Also:

Options(java.lang.String...)

GetChangelistDiffsOptions

public GetChangelistDiffsOptions(boolean outputShelvedDiffs,
                                 boolean rcsDiffs,
                                 int diffContext,
                                 boolean summaryDiff,
                                 int unifiedDiff,
                                 boolean ignoreWhitespaceChanges,
                                 boolean ignoreWhitespace,
                                 boolean ignoreLineEndings)

Explicit-value constructor.

Parameters:

outputShelvedDiffs - outputShelvedDiffs

rcsDiffs - rcsDiffs

diffContext - diffContext

summaryDiff - summaryDiff

unifiedDiff - unifiedDiff

ignoreWhitespaceChanges - ignoreWhitespaceChanges

ignoreWhitespace - ignoreWhitespace

ignoreLineEndings - ignoreLineEndings

Method Detail

processOptions

public java.util.List<java.lang.String> processOptions(IServer server)
                                                throws OptionsException

Description copied from class: Options

Turn this (specific) options object into a list of strings to be sent to the Perforce server as options for a specific command. As a side effect, set the option list associated with this Option to the result.

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.

Specified by:

processOptions in class Options

Parameters:

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...

Returns:

non-null (but possibly empty) string list representing the normalized Perforce server arguments corresponding to the state of this specific options object.

Throws:

OptionsException - if an error occurs in options processing that is not some species of ConnectionException, RequestException, AccessException, etc.

See Also:

Options.processOptions(com.perforce.p4java.server.IServer)

isOutputShelvedDiffs

public boolean isOutputShelvedDiffs()

setOutputShelvedDiffs

public GetChangelistDiffsOptions setOutputShelvedDiffs(boolean outputShelvedDiffs)

isRcsDiffs

public boolean isRcsDiffs()

setRcsDiffs

public GetChangelistDiffsOptions setRcsDiffs(boolean rcsDiffs)

Specified by:

setRcsDiffs in interface DiffsOptions<GetChangelistDiffsOptions>

getDiffContext

public int getDiffContext()

setDiffContext

public GetChangelistDiffsOptions setDiffContext(int diffContext)

Specified by:

setDiffContext in interface DiffsOptions<GetChangelistDiffsOptions>

isSummaryDiff

public boolean isSummaryDiff()

setSummaryDiff

public GetChangelistDiffsOptions setSummaryDiff(boolean summaryDiff)

Specified by:

setSummaryDiff in interface DiffsOptions<GetChangelistDiffsOptions>

isUnifiedDiff

public int isUnifiedDiff()

setUnifiedDiff

public GetChangelistDiffsOptions setUnifiedDiff(int unifiedDiff)

Specified by:

setUnifiedDiff in interface DiffsOptions<GetChangelistDiffsOptions>

isIgnoreWhitespaceChanges

public boolean isIgnoreWhitespaceChanges()

setIgnoreWhitespaceChanges

public GetChangelistDiffsOptions setIgnoreWhitespaceChanges(boolean ignoreWhitespaceChanges)

Specified by:

setIgnoreWhitespaceChanges in interface DiffsOptions<GetChangelistDiffsOptions>

isIgnoreWhitespace

public boolean isIgnoreWhitespace()

setIgnoreWhitespace

public GetChangelistDiffsOptions setIgnoreWhitespace(boolean ignoreWhitespace)

Specified by:

setIgnoreWhitespace in interface DiffsOptions<GetChangelistDiffsOptions>

isIgnoreLineEndings

public boolean isIgnoreLineEndings()

setIgnoreLineEndings

public GetChangelistDiffsOptions setIgnoreLineEndings(boolean ignoreLineEndings)

Specified by:

setIgnoreLineEndings in interface DiffsOptions<GetChangelistDiffsOptions>