com.perforce.p4java.option.server
Class GetExtendedFilesOptions

java.lang.Object
  com.perforce.p4java.option.Options
      com.perforce.p4java.option.server.GetExtendedFilesOptions

public class GetExtendedFilesOptions
extends Options

Options class for the IOptionsServer getExtendedFiles (a.k.a. "fstat") method.

The various options are too complex to be described in a few sentences here, and the various option arguments reflect this complexity. Note also that several options below (e.g. the "-F" equivalent) may only be available for later-model servers; use of these with earlier servers will typically cause RequestExceptions from the server (at least). Note further that no attempt is made with the default implementation here to sanity check the complex set of options for consistency.

Please consult the main p4 documentation for detailed options semantics and option / server compatibility details.

See Also:

IOptionsServer.getExtendedFiles(java.util.List, com.perforce.p4java.option.server.GetExtendedFilesOptions)

Field Summary

protected int	affectedByChangelist -e
protected FileStatAncilliaryOptions	ancilliaryOptions -Ox options
protected String	attributePattern fstat -A pattern (unsupported -- see 'p4 undoc' fstat entry).
protected String	filterString -F
protected int	maxResults -m
static String	OPTIONS_SPECS Recognized p4 fstat options: -F filter -m max -r -c -e changelist# -Ox -Rx -Sx; but note that the -Ox and -Rx options are not processed using the OPTIONS_SPEC string.
protected FileStatOutputOptions	outputOptions -Rx options
protected boolean	reverseSort -r
protected int	sinceChangelist -c
protected boolean	sortByDate -Sd
protected boolean	sortByFileSize -Ss
protected boolean	sortByFiletype -St
protected boolean	sortByHaveRev -Sh
protected boolean	sortByHeadRev -Sr

Fields inherited from class com.perforce.p4java.option.Options

immutable, optionList, OPTPFX

Constructor Summary

GetExtendedFilesOptions()
Default constructor -- sets all fields to null, IChangelist.UNKNOWN, false, or zero.

GetExtendedFilesOptions(String... options)
String-based constructor; possible options include -F filter -m max -r -c -e changelist# -Ox -Rx -Sx.

GetExtendedFilesOptions(String filterString, int maxResults, boolean reverseSort, int sinceChangelist, int affectedByChangelist, boolean sortByFiletype, boolean sortByDate, boolean sortByHeadRev, boolean sortByHaveRev, boolean sortByFileSize, FileStatOutputOptions outputOptions, FileStatAncilliaryOptions ancilliaryOptions)
Explicit-value constructor (release 2010.1).

GetExtendedFilesOptions(String filterString, int maxResults, boolean reverseSort, int sinceChangelist, int affectedByChangelist, boolean sortByFiletype, boolean sortByDate, boolean sortByHeadRev, boolean sortByHaveRev, boolean sortByFileSize, FileStatOutputOptions outputOptions, FileStatAncilliaryOptions ancilliaryOptions, String attributePattern)
Explicit-value constructor.

Method Summary

int	getAffectedByChangelist()
FileStatAncilliaryOptions	getAncilliaryOptions()
String	getAttributePattern()
String	getFilterString()
int	getMaxResults()
FileStatOutputOptions	getOutputOptions()
int	getSinceChangelist()
boolean	isReverseSort()
boolean	isSortByDate()
boolean	isSortByFileSize()
boolean	isSortByFiletype()
boolean	isSortByHaveRev()
boolean	isSortByHeadRev()
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.
GetExtendedFilesOptions	setAffectedByChangelist(int affectedByChangelist)
GetExtendedFilesOptions	setAncilliaryOptions(FileStatAncilliaryOptions ancilliaryOptions)
GetExtendedFilesOptions	setAttributePattern(String attributePattern)
GetExtendedFilesOptions	setFilterString(String filterString)
GetExtendedFilesOptions	setMaxResults(int maxResults)
GetExtendedFilesOptions	setOutputOptions(FileStatOutputOptions outputOptions)
GetExtendedFilesOptions	setReverseSort(boolean reverseSort)
GetExtendedFilesOptions	setSinceChangelist(int sinceChangelist)
GetExtendedFilesOptions	setSortByDate(boolean sortByDate)
GetExtendedFilesOptions	setSortByFileSize(boolean sortByFileSize)
GetExtendedFilesOptions	setSortByFiletype(boolean sortByFiletype)
GetExtendedFilesOptions	setSortByHaveRev(boolean sortByHaveRev)
GetExtendedFilesOptions	setSortByHeadRev(boolean sortByHeadRev)

Methods inherited from class com.perforce.p4java.option.Options

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

Recognized p4 fstat options: -F filter -m max -r -c -e changelist# -Ox -Rx -Sx; but note that the -Ox and -Rx options are not processed using the OPTIONS_SPEC string.

See Also:

Constant Field Values

filterString

protected String filterString

-F

maxResults

protected int maxResults

-m

reverseSort

protected boolean reverseSort

-r

sinceChangelist

protected int sinceChangelist

-c

affectedByChangelist

protected int affectedByChangelist

-e

sortByFiletype

protected boolean sortByFiletype

-St

sortByDate

protected boolean sortByDate

-Sd

sortByHeadRev

protected boolean sortByHeadRev

-Sr

sortByHaveRev

protected boolean sortByHaveRev

-Sh

sortByFileSize

protected boolean sortByFileSize

-Ss

outputOptions

protected FileStatOutputOptions outputOptions

-Rx options

ancilliaryOptions

protected FileStatAncilliaryOptions ancilliaryOptions

-Ox options

attributePattern

protected String attributePattern

fstat -A pattern (unsupported -- see 'p4 undoc' fstat entry).

Constructor Detail

GetExtendedFilesOptions

public GetExtendedFilesOptions()

Default constructor -- sets all fields to null, IChangelist.UNKNOWN, false, or zero.

GetExtendedFilesOptions

public GetExtendedFilesOptions(String... options)

String-based constructor; possible options include -F filter -m max -r -c -e changelist# -Ox -Rx -Sx.

Parameters:

options - string options

GetExtendedFilesOptions

public GetExtendedFilesOptions(String filterString,
                               int maxResults,
                               boolean reverseSort,
                               int sinceChangelist,
                               int affectedByChangelist,
                               boolean sortByFiletype,
                               boolean sortByDate,
                               boolean sortByHeadRev,
                               boolean sortByHaveRev,
                               boolean sortByFileSize,
                               FileStatOutputOptions outputOptions,
                               FileStatAncilliaryOptions ancilliaryOptions)

Explicit-value constructor (release 2010.1).

GetExtendedFilesOptions

public GetExtendedFilesOptions(String filterString,
                               int maxResults,
                               boolean reverseSort,
                               int sinceChangelist,
                               int affectedByChangelist,
                               boolean sortByFiletype,
                               boolean sortByDate,
                               boolean sortByHeadRev,
                               boolean sortByHaveRev,
                               boolean sortByFileSize,
                               FileStatOutputOptions outputOptions,
                               FileStatAncilliaryOptions ancilliaryOptions,
                               String attributePattern)

Explicit-value constructor.

Since:

2011.1

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)

getFilterString

public String getFilterString()

setFilterString

public GetExtendedFilesOptions setFilterString(String filterString)

getMaxResults

public int getMaxResults()

setMaxResults

public GetExtendedFilesOptions setMaxResults(int maxResults)

isReverseSort

public boolean isReverseSort()

setReverseSort

public GetExtendedFilesOptions setReverseSort(boolean reverseSort)

getSinceChangelist

public int getSinceChangelist()

setSinceChangelist

public GetExtendedFilesOptions setSinceChangelist(int sinceChangelist)

getAffectedByChangelist

public int getAffectedByChangelist()

setAffectedByChangelist

public GetExtendedFilesOptions setAffectedByChangelist(int affectedByChangelist)

isSortByFiletype

public boolean isSortByFiletype()

setSortByFiletype

public GetExtendedFilesOptions setSortByFiletype(boolean sortByFiletype)

isSortByDate

public boolean isSortByDate()

setSortByDate

public GetExtendedFilesOptions setSortByDate(boolean sortByDate)

isSortByHeadRev

public boolean isSortByHeadRev()

setSortByHeadRev

public GetExtendedFilesOptions setSortByHeadRev(boolean sortByHeadRev)

isSortByHaveRev

public boolean isSortByHaveRev()

setSortByHaveRev

public GetExtendedFilesOptions setSortByHaveRev(boolean sortByHaveRev)

isSortByFileSize

public boolean isSortByFileSize()

setSortByFileSize

public GetExtendedFilesOptions setSortByFileSize(boolean sortByFileSize)

getOutputOptions

public FileStatOutputOptions getOutputOptions()

setOutputOptions

public GetExtendedFilesOptions setOutputOptions(FileStatOutputOptions outputOptions)

getAncilliaryOptions

public FileStatAncilliaryOptions getAncilliaryOptions()

setAncilliaryOptions

public GetExtendedFilesOptions setAncilliaryOptions(FileStatAncilliaryOptions ancilliaryOptions)

getAttributePattern

public String getAttributePattern()

setAttributePattern

public GetExtendedFilesOptions setAttributePattern(String attributePattern)