com.perforce.p4java.option.Options
com.perforce.p4java.option.server.OpenedFilesOptions
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object
public class OpenedFilesOptions
Options-based method options for IServer and IClient openedFiles method(s).
Note that when used with the IClient openedFiles method, the allClients and clientName options are ignored; the clientName is (of course) filled in using the client's own name.
com.perforce.p4java.server.IServer#getOpenedFiles(java.util.List, com.perforce.p4java.core.option.OpenedFilesOptions),
IClient.openedFiles(java.util.List, com.perforce.p4java.option.server.OpenedFilesOptions)| Field Summary | |
|---|---|
protected boolean |
allClients
If true, list opened files in all clients. |
protected int |
changelistId
If non-negative, restrict the list to files opened under the given changelist#. |
protected String |
clientName
If not null, restrict the list of files to those opened on the named client. |
protected int |
maxFiles
If positive, limit output to the first 'maxFiles' number of files. |
static String |
OPTIONS_SPECS
Options: -a, -c[changelist], -C[client], -u[user], -m[max], -s |
protected boolean |
shortOutput
If true, produce 'short' (no revision number or file type) and optimized output when used with the -a (all clients) option. |
protected String |
userName
If not null, restrict the list of files to those opened by the named user. |
| Fields inherited from class com.perforce.p4java.option.Options |
|---|
immutable, optionList, OPTPFX |
| Constructor Summary | |
|---|---|
OpenedFilesOptions()
Default constructor. |
|
OpenedFilesOptions(boolean allClients,
String clientName,
int maxFiles,
String userName,
int changelistId)
Explicit-value constructor. |
|
OpenedFilesOptions(String... options)
Strings-based constructor; see 'p4 help [command]' for possible options. |
|
| Method Summary | |
|---|---|
int |
getChangelistId()
|
String |
getClientName()
|
int |
getMaxFiles()
|
String |
getUserName()
|
boolean |
isAllClients()
|
boolean |
isShortOutput()
|
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. |
OpenedFilesOptions |
setAllClients(boolean allClients)
|
OpenedFilesOptions |
setChangelistId(int changelistId)
|
OpenedFilesOptions |
setClientName(String clientName)
|
OpenedFilesOptions |
setMaxFiles(int maxFiles)
|
OpenedFilesOptions |
setShortOutput(boolean shortOutput)
|
OpenedFilesOptions |
setUserName(String userName)
|
| 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
protected boolean allClients
protected String clientName
protected int maxFiles
protected String userName
protected int changelistId
protected boolean shortOutput
| Constructor Detail |
|---|
public OpenedFilesOptions()
public OpenedFilesOptions(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 OpenedFilesOptions(boolean allClients,
String clientName,
int maxFiles,
String userName,
int changelistId)
| 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 boolean isAllClients()
public OpenedFilesOptions setAllClients(boolean allClients)
public String getClientName()
public OpenedFilesOptions setClientName(String clientName)
public int getMaxFiles()
public OpenedFilesOptions setMaxFiles(int maxFiles)
public String getUserName()
public OpenedFilesOptions setUserName(String userName)
public int getChangelistId()
public OpenedFilesOptions setChangelistId(int changelistId)
public boolean isShortOutput()
public OpenedFilesOptions setShortOutput(boolean shortOutput)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||