public class GetClientsOptions extends Options
Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
caseInsensitiveNameFilter
If non-null, limits output to clients whose name matches (case-insensitive)
the nameFilter pattern.
|
protected int |
maxResults
If greater than zero, limit output to the first maxResults
number of clients.
|
protected java.lang.String |
nameFilter
If non-null, limits output to clients whose name matches
the nameFilter pattern.
|
static java.lang.String |
OPTIONS_SPECS
Options: -m[max], -u[user], -e[nameFilter], -E[nameFilter], -t, -S[stream]
|
protected boolean |
showTime
If true, displays the time as well as the date.
|
protected java.lang.String |
stream
If non-null, limits output to the client workspaces dedicated to the
stream.
|
protected boolean |
unloaded
If true, lists unloaded clients.
|
protected java.lang.String |
userName
If non-null, limit qualifying clients to those owned by the named user.
|
immutable, optionList
Constructor and Description |
---|
GetClientsOptions()
Default constructor.
|
GetClientsOptions(boolean showTime,
java.lang.String userName,
java.lang.String caseInsensitiveNameFilter,
int maxResults,
java.lang.String stream)
Explicit-value constructor.
|
GetClientsOptions(int maxResults,
java.lang.String userName,
java.lang.String nameFilter)
Explicit-value constructor.
|
GetClientsOptions(int maxResults,
java.lang.String userName,
java.lang.String nameFilter,
boolean showTime)
Explicit-value constructor.
|
GetClientsOptions(int maxResults,
java.lang.String userName,
java.lang.String nameFilter,
boolean showTime,
java.lang.String stream)
Explicit-value constructor.
|
GetClientsOptions(java.lang.String... options)
Strings-based constructor; see 'p4 help [command]' for possible options.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getCaseInsensitiveNameFilter() |
int |
getMaxResults() |
java.lang.String |
getNameFilter() |
java.lang.String |
getStream() |
java.lang.String |
getUserName() |
boolean |
isShowTime() |
boolean |
isUnloaded() |
java.util.List<java.lang.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.
|
GetClientsOptions |
setCaseInsensitiveNameFilter(java.lang.String caseInsensitiveNameFilter) |
GetClientsOptions |
setMaxResults(int maxResults) |
GetClientsOptions |
setNameFilter(java.lang.String nameFilter) |
GetClientsOptions |
setShowTime(boolean showTime) |
GetClientsOptions |
setStream(java.lang.String stream) |
GetClientsOptions |
setUnloaded(boolean unloaded) |
GetClientsOptions |
setUserName(java.lang.String userName) |
getOptions, isImmutable, processFields, setImmutable, setOptions
public static final java.lang.String OPTIONS_SPECS
Options: -U
protected java.lang.String userName
protected java.lang.String nameFilter
protected java.lang.String caseInsensitiveNameFilter
protected int maxResults
protected boolean showTime
protected java.lang.String stream
protected boolean unloaded
public GetClientsOptions()
public GetClientsOptions(java.lang.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
- optionsOptions(java.lang.String...)
public GetClientsOptions(int maxResults, java.lang.String userName, java.lang.String nameFilter)
maxResults
- maxResultsuserName
- userNamenameFilter
- nameFilterpublic GetClientsOptions(int maxResults, java.lang.String userName, java.lang.String nameFilter, boolean showTime)
maxResults
- maxResultsuserName
- userNamenameFilter
- nameFiltershowTime
- showTimepublic GetClientsOptions(int maxResults, java.lang.String userName, java.lang.String nameFilter, boolean showTime, java.lang.String stream)
maxResults
- maxResultsuserName
- userNamenameFilter
- nameFiltershowTime
- showTimestream
- streampublic GetClientsOptions(boolean showTime, java.lang.String userName, java.lang.String caseInsensitiveNameFilter, int maxResults, java.lang.String stream)
showTime
- showTimeuserName
- userNamecaseInsensitiveNameFilter
- caseInsensitiveNameFiltermaxResults
- maxResultsstream
- streampublic java.util.List<java.lang.String> processOptions(IServer server) throws OptionsException
Options
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.
processOptions
in class Options
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...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 int getMaxResults()
public GetClientsOptions setMaxResults(int maxResults)
public java.lang.String getUserName()
public GetClientsOptions setUserName(java.lang.String userName)
public java.lang.String getNameFilter()
public GetClientsOptions setNameFilter(java.lang.String nameFilter)
public java.lang.String getCaseInsensitiveNameFilter()
public GetClientsOptions setCaseInsensitiveNameFilter(java.lang.String caseInsensitiveNameFilter)
public boolean isShowTime()
public GetClientsOptions setShowTime(boolean showTime)
public java.lang.String getStream()
public GetClientsOptions setStream(java.lang.String stream)
public boolean isUnloaded()
public GetClientsOptions setUnloaded(boolean unloaded)