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 GetFileSizesOptions

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

public class GetFileSizesOptions
extends Options

Options class for IOptionsServer.getFileSizes method.

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

Field Summary
protected  boolean allRevisions
          If true, lists all revisions within the specific range, rather than just the highest revision in the range.
protected  boolean archivedFiles
          If true, list files in archive depots (see 'p4 help archive').
protected  long blockSize
          If greater than zero, specifies the block size in bytes.
protected  int maxFiles
          If positive, limits sizes to the first 'max' number of files.
protected  boolean omitLazyCopies
          If true, omits lazy copies when calculating the file sizes for the specified files.
static String OPTIONS_SPECS
           Options: [-a -S] [-s | -z] [-b blocksize] [-m max] -A [-s] [-b blocksize] [-m max] -U
protected  boolean shelvedFiles
          If true, list size information for shelved files only.
protected  boolean sumFileSizes
          If true, calculates the sum of the file sizes for the specified files.
protected  boolean unloadedFiles
          If true, list size information for unload files in the unload depot (see 'p4 help unload').
 
Fields inherited from class com.perforce.p4java.option.Options
immutable, optionList, OPTPFX
 
Constructor Summary
GetFileSizesOptions()
          Default constructor.
GetFileSizesOptions(String... options)
          Strings-based constructor; see 'p4 help [command]' for possible options.
 
Method Summary
 long getBlockSize()
           
 int getMaxFiles()
           
 boolean isAllRevisions()
           
 boolean isArchivedFiles()
           
 boolean isOmitLazyCopies()
           
 boolean isShelvedFiles()
           
 boolean isSumFileSizes()
           
 boolean isUnloadedFiles()
           
 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.
 GetFileSizesOptions setAllRevisions(boolean allRevisions)
           
 GetFileSizesOptions setArchivedFiles(boolean archivedFiles)
           
 GetFileSizesOptions setBlockSize(long blockSize)
           
 GetFileSizesOptions setMaxFiles(int maxFiles)
           
 GetFileSizesOptions setOmitLazyCopies(boolean omitLazyCopies)
           
 GetFileSizesOptions setShelvedFiles(boolean shelvedFiles)
           
 GetFileSizesOptions setSumFileSizes(boolean sumFileSizes)
           
 GetFileSizesOptions setUnloadedFiles(boolean unloadedFiles)
           
 
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 -S] [-s | -z] [-b blocksize] [-m max]
                -A [-s] [-b blocksize] [-m max]
                -U

See Also:
Constant Field Values

allRevisions

protected boolean allRevisions
If true, lists all revisions within the specific range, rather than just the highest revision in the range. Corresponds to the -a flag.

shelvedFiles

protected boolean shelvedFiles
If true, list size information for shelved files only. With this option, revision specifications are not permitted. Corresponds to the -S flag.

archivedFiles

protected boolean archivedFiles
If true, list files in archive depots (see 'p4 help archive'). Corresponds to the -A flag.

unloadedFiles

protected boolean unloadedFiles
If true, list size information for unload files in the unload depot (see 'p4 help unload'). Corresponds to the -U flag.

sumFileSizes

protected boolean sumFileSizes
If true, calculates the sum of the file sizes for the specified files. Corresponds to the -s flag.

omitLazyCopies

protected boolean omitLazyCopies
If true, omits lazy copies when calculating the file sizes for the specified files. Corresponds to the -z flag.

blockSize

protected long blockSize
If greater than zero, specifies the block size in bytes. When this option is specified, each accumulated filesize is rounded up to the nearest blocksize. Corresponds to the -b flag.

maxFiles

protected int maxFiles
If positive, limits sizes to the first 'max' number of files. Corresponds to the -m flag.

Constructor Detail

GetFileSizesOptions

public GetFileSizesOptions()
Default constructor.

GetFileSizesOptions

public GetFileSizesOptions(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)

isAllRevisions

public boolean isAllRevisions()

setAllRevisions

public GetFileSizesOptions setAllRevisions(boolean allRevisions)

isShelvedFiles

public boolean isShelvedFiles()

setShelvedFiles

public GetFileSizesOptions setShelvedFiles(boolean shelvedFiles)

isArchivedFiles

public boolean isArchivedFiles()

setArchivedFiles

public GetFileSizesOptions setArchivedFiles(boolean archivedFiles)

isUnloadedFiles

public boolean isUnloadedFiles()

setUnloadedFiles

public GetFileSizesOptions setUnloadedFiles(boolean unloadedFiles)

isSumFileSizes

public boolean isSumFileSizes()

setSumFileSizes

public GetFileSizesOptions setSumFileSizes(boolean sumFileSizes)

isOmitLazyCopies

public boolean isOmitLazyCopies()

setOmitLazyCopies

public GetFileSizesOptions setOmitLazyCopies(boolean omitLazyCopies)

getBlockSize

public long getBlockSize()

setBlockSize

public GetFileSizesOptions setBlockSize(long blockSize)

getMaxFiles

public int getMaxFiles()

setMaxFiles

public GetFileSizesOptions setMaxFiles(int maxFiles)
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.