Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.perforce.p4java.option.server
Class GetFileDiffsOptions

java.lang.Object
  extended by com.perforce.p4java.option.Options
      extended by com.perforce.p4java.option.server.GetFileDiffsOptions

public class GetFileDiffsOptions
extends Options

Options class for the IOptionsServer getFileDiffs methods.

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.
protected  boolean includeNonTextDiffs
          If true, diff even files with non-text (binary) types.
static String OPTIONS_SPECS
          Options: -d[flags], -Od, -q, -t, -u, -dc[n], -du[n], -S[stream], -P[parentStream]
protected  boolean outputDifferFilesOnly
          If true, limits output to files that differ.
protected  String parentStream
          If non-null, specify a parent stream other than the stream's actual parent.
protected  boolean quiet
          If true, suppresses the display of the header lines of files whose content and types are identical and suppresses the actual diff for all files.
protected  boolean rcsDiffs
          If true, use RCS diff; corresponds to -dn.
protected  String stream
          If not null, makes 'p4 diff2' use a stream's branch view.
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
GetFileDiffsOptions()
          Default constructor.
GetFileDiffsOptions(boolean quiet, boolean includeNonTextDiffs, boolean gnuDiffs, boolean rcsDiffs, int diffContext, boolean summaryDiff, int unifiedDiff, boolean ignoreWhitespaceChanges, boolean ignoreWhitespace, boolean ignoreLineEndings)
          Explicit-value constructor.
GetFileDiffsOptions(boolean quiet, boolean includeNonTextDiffs, boolean gnuDiffs, boolean rcsDiffs, int diffContext, boolean summaryDiff, int unifiedDiff, boolean ignoreWhitespaceChanges, boolean ignoreWhitespace, boolean ignoreLineEndings, String stream, String parentStream)
          Explicit-value constructor.
GetFileDiffsOptions(String... options)
          Strings-based constructor; see 'p4 help [command]' for possible options.
 
Method Summary
 int getDiffContext()
           
 String getParentStream()
           
 String getStream()
           
 boolean isGnuDiffs()
           
 boolean isIgnoreLineEndings()
           
 boolean isIgnoreWhitespace()
           
 boolean isIgnoreWhitespaceChanges()
           
 boolean isIncludeNonTextDiffs()
           
 boolean isOutputDifferFilesOnly()
           
 boolean isQuiet()
           
 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.
 GetFileDiffsOptions setDiffContext(int diffContext)
           
 GetFileDiffsOptions setGnuDiffs(boolean gnuDiffs)
           
 GetFileDiffsOptions setIgnoreLineEndings(boolean ignoreLineEndings)
           
 GetFileDiffsOptions setIgnoreWhitespace(boolean ignoreWhitespace)
           
 GetFileDiffsOptions setIgnoreWhitespaceChanges(boolean ignoreWhitespaceChanges)
           
 GetFileDiffsOptions setIncludeNonTextDiffs(boolean includeNonTextDiffs)
           
 GetFileDiffsOptions setOutputDifferFilesOnly(boolean outputDifferFilesOnly)
           
 GetFileDiffsOptions setParentStream(String parentStream)
           
 GetFileDiffsOptions setQuiet(boolean quiet)
           
 GetFileDiffsOptions setRcsDiffs(boolean rcsDiffs)
           
 GetFileDiffsOptions setStream(String stream)
           
 GetFileDiffsOptions setSummaryDiff(boolean summaryDiff)
           
 GetFileDiffsOptions 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

OPTIONS_SPECS

public static final String OPTIONS_SPECS
Options: -d[flags], -Od, -q, -t, -u, -dc[n], -du[n], -S[stream], -P[parentStream]

See Also:
Constant Field Values

outputDifferFilesOnly

protected boolean outputDifferFilesOnly
If true, limits output to files that differ. Corresponds to -Od.

quiet

protected boolean quiet
If true, suppresses the display of the header lines of files whose content and types are identical and suppresses the actual diff for all files. Corresponds to the -q flag.

includeNonTextDiffs

protected boolean includeNonTextDiffs
If true, diff even files with non-text (binary) types. Corresponds to the -t flag.

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.

stream

protected String stream
If not null, makes 'p4 diff2' use a stream's branch view. The source is the stream itself, and the target is the stream's parent. The '-P' flag can be used to specify a parent stream other than the stream's actual parent.

parentStream

protected String parentStream
If non-null, specify a parent stream other than the stream's actual parent. Corresponds to -P flag.

Constructor Detail

GetFileDiffsOptions

public GetFileDiffsOptions()
Default constructor.

GetFileDiffsOptions

public GetFileDiffsOptions(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.

See Also:
Options.Options(java.lang.String...)

GetFileDiffsOptions

public GetFileDiffsOptions(boolean quiet,
                           boolean includeNonTextDiffs,
                           boolean gnuDiffs,
                           boolean rcsDiffs,
                           int diffContext,
                           boolean summaryDiff,
                           int unifiedDiff,
                           boolean ignoreWhitespaceChanges,
                           boolean ignoreWhitespace,
                           boolean ignoreLineEndings)
Explicit-value constructor.

GetFileDiffsOptions

public GetFileDiffsOptions(boolean quiet,
                           boolean includeNonTextDiffs,
                           boolean gnuDiffs,
                           boolean rcsDiffs,
                           int diffContext,
                           boolean summaryDiff,
                           int unifiedDiff,
                           boolean ignoreWhitespaceChanges,
                           boolean ignoreWhitespace,
                           boolean ignoreLineEndings,
                           String stream,
                           String parentStream)
Explicit-value constructor.

Method Detail

processOptions

public List<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)

isOutputDifferFilesOnly

public boolean isOutputDifferFilesOnly()

setOutputDifferFilesOnly

public GetFileDiffsOptions setOutputDifferFilesOnly(boolean outputDifferFilesOnly)

isQuiet

public boolean isQuiet()

setQuiet

public GetFileDiffsOptions setQuiet(boolean quiet)

isIncludeNonTextDiffs

public boolean isIncludeNonTextDiffs()

setIncludeNonTextDiffs

public GetFileDiffsOptions setIncludeNonTextDiffs(boolean includeNonTextDiffs)

isGnuDiffs

public boolean isGnuDiffs()

setGnuDiffs

public GetFileDiffsOptions setGnuDiffs(boolean gnuDiffs)

isRcsDiffs

public boolean isRcsDiffs()

setRcsDiffs

public GetFileDiffsOptions setRcsDiffs(boolean rcsDiffs)

getDiffContext

public int getDiffContext()

setDiffContext

public GetFileDiffsOptions setDiffContext(int diffContext)

isSummaryDiff

public boolean isSummaryDiff()

setSummaryDiff

public GetFileDiffsOptions setSummaryDiff(boolean summaryDiff)

isUnifiedDiff

public int isUnifiedDiff()

setUnifiedDiff

public GetFileDiffsOptions setUnifiedDiff(int unifiedDiff)

isIgnoreWhitespaceChanges

public boolean isIgnoreWhitespaceChanges()

setIgnoreWhitespaceChanges

public GetFileDiffsOptions setIgnoreWhitespaceChanges(boolean ignoreWhitespaceChanges)

isIgnoreWhitespace

public boolean isIgnoreWhitespace()

setIgnoreWhitespace

public GetFileDiffsOptions setIgnoreWhitespace(boolean ignoreWhitespace)

isIgnoreLineEndings

public boolean isIgnoreLineEndings()

setIgnoreLineEndings

public GetFileDiffsOptions setIgnoreLineEndings(boolean ignoreLineEndings)

getStream

public String getStream()

setStream

public GetFileDiffsOptions setStream(String stream)

getParentStream

public String getParentStream()

setParentStream

public GetFileDiffsOptions setParentStream(String parentStream)
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2015 Perforce Software. All Rights Reserved.