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 GetFixesOptions

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

public class GetFixesOptions
extends Options

Options subclass for the IServer.getFixList method.

Field Summary
protected  int changelistId
          If non-negative, only fixes from the numbered changelist are listed.
protected  boolean includeIntegrations
          If true, include any fixes made by changelists integrated into the specified files.
protected  String jobId
          If non-null, only fixes for the named job are listed.
protected  int maxFixes
          If positive, restrict the list to the first maxFixes fixes.
static String OPTIONS_SPECS
          Options: c[changelist], -j[job], -i, m[max]
 
Fields inherited from class com.perforce.p4java.option.Options
immutable, optionList, OPTPFX
 
Constructor Summary
GetFixesOptions()
          Default constructor.
GetFixesOptions(int changelistId, String jobId, boolean includeIntegrations, int maxFixes)
          Explicit-value constructor.
GetFixesOptions(String... options)
          Strings-based constructor; see 'p4 help [command]' for possible options.
 
Method Summary
 int getChangelistId()
           
 String getJobId()
           
 int getMaxFixes()
           
 boolean isIncludeIntegrations()
           
 List<String> processOptions(IServer server)
          IServer.getFixList-specific options processing.
 GetFixesOptions setChangelistId(int changelistId)
           
 GetFixesOptions setIncludeIntegrations(boolean includeIntegrations)
           
 GetFixesOptions setJobId(String jobId)
           
 GetFixesOptions setMaxFixes(int maxFixes)
           
 
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: c[changelist], -j[job], -i, m[max]

See Also:
Constant Field Values

changelistId

protected int changelistId
If non-negative, only fixes from the numbered changelist are listed. Corresponds to -c.

jobId

protected String jobId
If non-null, only fixes for the named job are listed. Corresponds to -j.

includeIntegrations

protected boolean includeIntegrations
If true, include any fixes made by changelists integrated into the specified files. Corresponds to -i.

maxFixes

protected int maxFixes
If positive, restrict the list to the first maxFixes fixes. Corresponds to -m.

Constructor Detail

GetFixesOptions

public GetFixesOptions()
Default constructor.

GetFixesOptions

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

GetFixesOptions

public GetFixesOptions(int changelistId,
                       String jobId,
                       boolean includeIntegrations,
                       int maxFixes)
Explicit-value constructor.

Method Detail

processOptions

public List<String> processOptions(IServer server)
                            throws OptionsException
IServer.getFixList-specific options processing. Uses the generic Options.processFields method to process options according to the static OPTIONS_SPECS field; will bypass processing if this.optionList is non-null; will set this.optionList if processing succeeds.

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)

getChangelistId

public int getChangelistId()

setChangelistId

public GetFixesOptions setChangelistId(int changelistId)

getJobId

public String getJobId()

setJobId

public GetFixesOptions setJobId(String jobId)

isIncludeIntegrations

public boolean isIncludeIntegrations()

setIncludeIntegrations

public GetFixesOptions setIncludeIntegrations(boolean includeIntegrations)

getMaxFixes

public int getMaxFixes()

setMaxFixes

public GetFixesOptions setMaxFixes(int maxFixes)
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.