com.perforce.p4java.option.Options
com.perforce.p4java.option.server.GetExtendedFilesOptions
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object
public class GetExtendedFilesOptions
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.
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
Options: -F[filter], -m[max], -r, -c, -e[changelist], -O[x], -R[x], -S[x], -A[pattern] |
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. |
|
GetExtendedFilesOptions(String... options)
Strings-based constructor; see 'p4 help [command]' for possible options. |
|
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. |
|
| 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 |
|---|
public static final String OPTIONS_SPECS
NOTE: the -O[x] and -R[x] options are not processed using the OPTIONS_SPEC string.
protected String filterString
protected int maxResults
protected boolean reverseSort
protected int sinceChangelist
protected int affectedByChangelist
protected boolean sortByFiletype
protected boolean sortByDate
protected boolean sortByHeadRev
protected boolean sortByHaveRev
protected boolean sortByFileSize
protected FileStatOutputOptions outputOptions
protected FileStatAncilliaryOptions ancilliaryOptions
protected String attributePattern
| Constructor Detail |
|---|
public GetExtendedFilesOptions()
public GetExtendedFilesOptions(String... 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.
Options.Options(java.lang.String...)
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)
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)
| Method Detail |
|---|
public List<String> processOptions(IServer server)
throws OptionsException
OptionsThe 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.
processOptions in class Optionsserver - 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...
OptionsException - if an error occurs in options processing that is
not some species of ConnectionException, RequestException,
AccessException, etc.Options.processOptions(com.perforce.p4java.server.IServer)public String getFilterString()
public GetExtendedFilesOptions setFilterString(String filterString)
public int getMaxResults()
public GetExtendedFilesOptions setMaxResults(int maxResults)
public boolean isReverseSort()
public GetExtendedFilesOptions setReverseSort(boolean reverseSort)
public int getSinceChangelist()
public GetExtendedFilesOptions setSinceChangelist(int sinceChangelist)
public int getAffectedByChangelist()
public GetExtendedFilesOptions setAffectedByChangelist(int affectedByChangelist)
public boolean isSortByFiletype()
public GetExtendedFilesOptions setSortByFiletype(boolean sortByFiletype)
public boolean isSortByDate()
public GetExtendedFilesOptions setSortByDate(boolean sortByDate)
public boolean isSortByHeadRev()
public GetExtendedFilesOptions setSortByHeadRev(boolean sortByHeadRev)
public boolean isSortByHaveRev()
public GetExtendedFilesOptions setSortByHaveRev(boolean sortByHaveRev)
public boolean isSortByFileSize()
public GetExtendedFilesOptions setSortByFileSize(boolean sortByFileSize)
public FileStatOutputOptions getOutputOptions()
public GetExtendedFilesOptions setOutputOptions(FileStatOutputOptions outputOptions)
public FileStatAncilliaryOptions getAncilliaryOptions()
public GetExtendedFilesOptions setAncilliaryOptions(FileStatAncilliaryOptions ancilliaryOptions)
public String getAttributePattern()
public GetExtendedFilesOptions setAttributePattern(String attributePattern)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||