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 GetFileAnnotationsOptions

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

public class GetFileAnnotationsOptions
extends Options

Options class for IOptionsServer getFileAnnotations method.

Note that this class can take both DiffType args and the string versions (-dw, etc.); mixing them up carelessly probably isn't a good idea.

See Also:
IOptionsServer.getFileAnnotations(java.util.List, com.perforce.p4java.option.server.GetFileAnnotationsOptions)

Field Summary
protected  boolean allResults
          If true, include both deleted files and lines no longer present at the head revision; corresponds to the -a flag.
protected  boolean followAllIntegrations
          If true, follows all integrations into the file; corresponds to -I.
protected  boolean followBranches
          If true, follow branches; corresponds to the -f flag.
protected  boolean ignoreLineEndings
          If true, ignore line endisngs; 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: -a, -c, -i, -db, -dw, -dl, -I, -q, -t
protected  boolean showBinaryContent
          If true, forces 'p4 annotate' to display binary files; corresponds to -t.
protected  boolean suppressHeader
          If true, suppresses the one-line header that is displayed by default for each file; corresponds to -q.
protected  boolean useChangeNumbers
          If true, annotate with change numbers rather than revision numbers with each line; correspond to the -c flag.
protected  DiffType wsOpts
          If non-null, use the DiffType value to determine whitespace options.
 
Fields inherited from class com.perforce.p4java.option.Options
immutable, optionList, OPTPFX
 
Constructor Summary
GetFileAnnotationsOptions()
          Default constructor.
GetFileAnnotationsOptions(boolean allResults, boolean useChangeNumbers, boolean followBranches, boolean ignoreWhitespaceChanges, boolean ignoreWhitespace, boolean ignoreLineEndings)
          Explicit value constructor.
GetFileAnnotationsOptions(boolean allResults, boolean useChangeNumbers, boolean followBranches, boolean ignoreWhitespaceChanges, boolean ignoreWhitespace, boolean ignoreLineEndings, boolean followAllIntegrations)
          Explicit value constructor.
GetFileAnnotationsOptions(boolean allResults, boolean useChangeNumbers, boolean followBranches, DiffType wsOpts)
          Explicit value constructor.
GetFileAnnotationsOptions(String... options)
          Strings-based constructor; see 'p4 help [command]' for possible options.
 
Method Summary
 DiffType getWsOpts()
           
 boolean isAllResults()
           
 boolean isFollowAllIntegrations()
           
 boolean isFollowBranches()
           
 boolean isIgnoreLineEndings()
           
 boolean isIgnoreWhitespace()
           
 boolean isIgnoreWhitespaceChanges()
           
 boolean isShowBinaryContent()
           
 boolean isSuppressHeader()
           
 boolean isUseChangeNumbers()
           
 List<String> processOptions(IServer server)
          If the wsOpts field is non-null, those values will override the corresponding explicit boolean fields.
 GetFileAnnotationsOptions setAllResults(boolean allResults)
           
 GetFileAnnotationsOptions setFollowAllIntegrations(boolean followAllIntegrations)
           
 GetFileAnnotationsOptions setFollowBranches(boolean followBranches)
           
 GetFileAnnotationsOptions setIgnoreLineEndings(boolean ignoreLineEndings)
           
 GetFileAnnotationsOptions setIgnoreWhitespace(boolean ignoreWhitespace)
           
 GetFileAnnotationsOptions setIgnoreWhitespaceChanges(boolean ignoreWhitespaceChanges)
           
 GetFileAnnotationsOptions setShowBinaryContent(boolean showBinaryContent)
           
 GetFileAnnotationsOptions setSuppressHeader(boolean suppressHeader)
           
 GetFileAnnotationsOptions setUseChangeNumbers(boolean useChangeNumbers)
           
 GetFileAnnotationsOptions setWsOpts(DiffType wsOpts)
           
 
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: -a, -c, -i, -db, -dw, -dl, -I, -q, -t

See Also:
Constant Field Values

allResults

protected boolean allResults
If true, include both deleted files and lines no longer present at the head revision; corresponds to the -a flag.

useChangeNumbers

protected boolean useChangeNumbers
If true, annotate with change numbers rather than revision numbers with each line; correspond to the -c flag.

followBranches

protected boolean followBranches
If true, follow branches; corresponds to the -f flag.

wsOpts

protected DiffType wsOpts
If non-null, use the DiffType value to determine whitespace options.

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 endisngs; corresponds to -dl.

followAllIntegrations

protected boolean followAllIntegrations
If true, follows all integrations into the file; corresponds to -I.

suppressHeader

protected boolean suppressHeader
If true, suppresses the one-line header that is displayed by default for each file; corresponds to -q.

showBinaryContent

protected boolean showBinaryContent
If true, forces 'p4 annotate' to display binary files; corresponds to -t.

Constructor Detail

GetFileAnnotationsOptions

public GetFileAnnotationsOptions()
Default constructor.

GetFileAnnotationsOptions

public GetFileAnnotationsOptions(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...)

GetFileAnnotationsOptions

public GetFileAnnotationsOptions(boolean allResults,
                                 boolean useChangeNumbers,
                                 boolean followBranches,
                                 DiffType wsOpts)
Explicit value constructor.

GetFileAnnotationsOptions

public GetFileAnnotationsOptions(boolean allResults,
                                 boolean useChangeNumbers,
                                 boolean followBranches,
                                 boolean ignoreWhitespaceChanges,
                                 boolean ignoreWhitespace,
                                 boolean ignoreLineEndings)
Explicit value constructor.

GetFileAnnotationsOptions

public GetFileAnnotationsOptions(boolean allResults,
                                 boolean useChangeNumbers,
                                 boolean followBranches,
                                 boolean ignoreWhitespaceChanges,
                                 boolean ignoreWhitespace,
                                 boolean ignoreLineEndings,
                                 boolean followAllIntegrations)
Explicit value constructor.

Method Detail

processOptions

public List<String> processOptions(IServer server)
                            throws OptionsException
If the wsOpts field is non-null, those values will override the corresponding explicit boolean fields.

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)

isAllResults

public boolean isAllResults()

setAllResults

public GetFileAnnotationsOptions setAllResults(boolean allResults)

isUseChangeNumbers

public boolean isUseChangeNumbers()

setUseChangeNumbers

public GetFileAnnotationsOptions setUseChangeNumbers(boolean useChangeNumbers)

isFollowBranches

public boolean isFollowBranches()

setFollowBranches

public GetFileAnnotationsOptions setFollowBranches(boolean followBranches)

getWsOpts

public DiffType getWsOpts()

setWsOpts

public GetFileAnnotationsOptions setWsOpts(DiffType wsOpts)

isIgnoreWhitespaceChanges

public boolean isIgnoreWhitespaceChanges()

setIgnoreWhitespaceChanges

public GetFileAnnotationsOptions setIgnoreWhitespaceChanges(boolean ignoreWhitespaceChanges)

isIgnoreWhitespace

public boolean isIgnoreWhitespace()

setIgnoreWhitespace

public GetFileAnnotationsOptions setIgnoreWhitespace(boolean ignoreWhitespace)

isIgnoreLineEndings

public boolean isIgnoreLineEndings()

setIgnoreLineEndings

public GetFileAnnotationsOptions setIgnoreLineEndings(boolean ignoreLineEndings)

isFollowAllIntegrations

public boolean isFollowAllIntegrations()

setFollowAllIntegrations

public GetFileAnnotationsOptions setFollowAllIntegrations(boolean followAllIntegrations)

isSuppressHeader

public boolean isSuppressHeader()

setSuppressHeader

public GetFileAnnotationsOptions setSuppressHeader(boolean suppressHeader)

isShowBinaryContent

public boolean isShowBinaryContent()

setShowBinaryContent

public GetFileAnnotationsOptions setShowBinaryContent(boolean showBinaryContent)
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.