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 VerifyFilesOptions

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

public class VerifyFilesOptions
extends Options

Options class for IOptionsServer.verifyFiles method.

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

Field Summary
protected  long batchSize
          If greater than zero, specifies the batch size.
protected  boolean computeDigest
          If true, computes and saves the digest for each revision, regardless of whether the revision already has a saved digest.
protected  boolean computeMissingDigest
          If true, computes and saves the digest only for revisions that have no saved digest.
protected  int maxRevisions
          If positive, specifies the maximum number of revisions to process.
static String OPTIONS_SPECS
           Options: [-t | -u | -v | -z] [-m max -q -s -X -b N] file[revRange] ...
protected  boolean quiet
          If true, minimizes command output, displaying only errors from mismatched digests or unreproducible revisions.
protected  boolean skipComputedDigest
          If true, optimizes digest computations by skipping revisions that have already been computed in the current pass.
protected  boolean skipPlusXModifier
          If true, specifies that files with the +X filetype modifier should be skipped.
protected  boolean transferContent
          If true, causes 'p4 verify' to schedule transfer of the content of any damaged revision.
protected  boolean verifySize
          If true, specifies that the file size should also be verified.
protected  boolean verifyUnload
          If true, verifies files in the unload depot (see 'p4 help unload').
 
Fields inherited from class com.perforce.p4java.option.Options
immutable, optionList, OPTPFX
 
Constructor Summary
VerifyFilesOptions()
          Default constructor.
VerifyFilesOptions(String... options)
          Strings-based constructor; see 'p4 help [command]' for possible options.
 
Method Summary
 long getBatchSize()
           
 int getMaxRevisions()
           
 boolean isComputeDigest()
           
 boolean isComputeMissingDigest()
           
 boolean isQuiet()
           
 boolean isSkipComputedDigest()
           
 boolean isSkipPlusXModifier()
           
 boolean isTransferContent()
           
 boolean isVerifySize()
           
 boolean isVerifyUnload()
           
 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.
 VerifyFilesOptions setBatchSize(long batchSize)
           
 VerifyFilesOptions setComputeDigest(boolean computeDigest)
           
 VerifyFilesOptions setComputeMissingDigest(boolean computeMissingDigest)
           
 VerifyFilesOptions setMaxRevisions(int maxRevisions)
           
 VerifyFilesOptions setQuiet(boolean quiet)
           
 VerifyFilesOptions setSkipComputedDigest(boolean skipComputedDigest)
           
 VerifyFilesOptions setSkipPlusXModifier(boolean skipPlusXModifier)
           
 VerifyFilesOptions setTransferContent(boolean transferContent)
           
 VerifyFilesOptions setVerifySize(boolean verifySize)
           
 VerifyFilesOptions setVerifyUnload(boolean verifyUnload)
           
 
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:
                [-t | -u | -v | -z] [-m max -q -s -X -b N] file[revRange] ...
                -U unloadfiles...

See Also:
Constant Field Values

transferContent

protected boolean transferContent
If true, causes 'p4 verify' to schedule transfer of the content of any damaged revision. This option is for use only with a replica server and cannot be used with the '-v' or '-u' options. Corresponds to the -t flag.

computeMissingDigest

protected boolean computeMissingDigest
If true, computes and saves the digest only for revisions that have no saved digest. Corresponds to the -u flag.

computeDigest

protected boolean computeDigest
If true, computes and saves the digest for each revision, regardless of whether the revision already has a saved digest. This option can be used to update the saved digest if the archive was deliberately changed. The '-u' and '-v' options are mutually exclusive. Corresponds to the -v flag.

skipComputedDigest

protected boolean skipComputedDigest
If true, optimizes digest computations by skipping revisions that have already been computed in the current pass. This option is useful when the specified files contain lazy copies. The resulting output might report a lazy copy revision if it is the first revision in the sort order to access a common archive file. This option cannot be used with the '-v' or '-u' options. Corresponds to the -z flag.

maxRevisions

protected int maxRevisions
If positive, specifies the maximum number of revisions to process. This option can be used with the -u flag to compute and save digests for a limited number of revisions in each 'p4 verify' invocation. Corresponds to the -z flag.

quiet

protected boolean quiet
If true, minimizes command output, displaying only errors from mismatched digests or unreproducible revisions. Corresponds to the -q flag.

verifySize

protected boolean verifySize
If true, specifies that the file size should also be verified. The -v flag implies the -s flag. Corresponds to the -s flag.

skipPlusXModifier

protected boolean skipPlusXModifier
If true, specifies that files with the +X filetype modifier should be skipped. Corresponds to the -s flag.

batchSize

protected long batchSize
If greater than zero, specifies the batch size. By default, 'p4 verify' processes files in batches of 10000 files at a time. Specify -b 0 to disable batching and process all files in a single batch. If the -z flag is specified, the -b flag is ignored and all files are processed in a single batch.. Corresponds to the -b N flag.

verifyUnload

protected boolean verifyUnload
If true, verifies files in the unload depot (see 'p4 help unload'). Corresponds to the -U flag.

Constructor Detail

VerifyFilesOptions

public VerifyFilesOptions()
Default constructor.

VerifyFilesOptions

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

isTransferContent

public boolean isTransferContent()

setTransferContent

public VerifyFilesOptions setTransferContent(boolean transferContent)

isComputeMissingDigest

public boolean isComputeMissingDigest()

setComputeMissingDigest

public VerifyFilesOptions setComputeMissingDigest(boolean computeMissingDigest)

isComputeDigest

public boolean isComputeDigest()

setComputeDigest

public VerifyFilesOptions setComputeDigest(boolean computeDigest)

isSkipComputedDigest

public boolean isSkipComputedDigest()

setSkipComputedDigest

public VerifyFilesOptions setSkipComputedDigest(boolean skipComputedDigest)

getMaxRevisions

public int getMaxRevisions()

setMaxRevisions

public VerifyFilesOptions setMaxRevisions(int maxRevisions)

isQuiet

public boolean isQuiet()

setQuiet

public VerifyFilesOptions setQuiet(boolean quiet)

isVerifySize

public boolean isVerifySize()

setVerifySize

public VerifyFilesOptions setVerifySize(boolean verifySize)

isSkipPlusXModifier

public boolean isSkipPlusXModifier()

setSkipPlusXModifier

public VerifyFilesOptions setSkipPlusXModifier(boolean skipPlusXModifier)

getBatchSize

public long getBatchSize()

setBatchSize

public VerifyFilesOptions setBatchSize(long batchSize)

isVerifyUnload

public boolean isVerifyUnload()

setVerifyUnload

public VerifyFilesOptions setVerifyUnload(boolean verifyUnload)
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.