|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.perforce.p4java.option.Options com.perforce.p4java.option.server.GetUsersOptions
public class GetUsersOptions
Options class for server getUsers method.
IOptionsServer.getUsers(java.util.List, com.perforce.p4java.option.server.GetUsersOptions)
Field Summary | |
---|---|
protected boolean |
extendedOutput
If true, include additional information in the output; corresponds to the -l flag. |
protected boolean |
includeServiceUsers
If true, include service users in the returned list; corresponds to the -a flag. |
protected int |
maxUsers
If positive, return only the first maxUsers users. |
static String |
OPTIONS_SPECS
Options: -m[max], -l, -a |
Fields inherited from class com.perforce.p4java.option.Options |
---|
immutable, optionList, OPTPFX |
Constructor Summary | |
---|---|
GetUsersOptions()
Default constructor. |
|
GetUsersOptions(int maxUsers)
Explicit-value constructor. |
|
GetUsersOptions(int maxUsers,
boolean includeServiceUsers,
boolean extendedOutput)
Explicit-value constructor. |
|
GetUsersOptions(String... options)
Strings-based constructor; see 'p4 help [command]' for possible options. |
Method Summary | |
---|---|
int |
getMaxUsers()
|
boolean |
isExtendedOutput()
|
boolean |
isIncludeServiceUsers()
|
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. |
GetUsersOptions |
setExtendedOutput(boolean extendedOutput)
|
GetUsersOptions |
setIncludeServiceUsers(boolean includeServiceUsers)
|
GetUsersOptions |
setMaxUsers(int maxUsers)
|
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 int maxUsers
protected boolean includeServiceUsers
protected boolean extendedOutput
Constructor Detail |
---|
public GetUsersOptions()
public GetUsersOptions(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 GetUsersOptions(int maxUsers)
public GetUsersOptions(int maxUsers, boolean includeServiceUsers, boolean extendedOutput)
Method Detail |
---|
public List<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 getMaxUsers()
public GetUsersOptions setMaxUsers(int maxUsers)
public boolean isIncludeServiceUsers()
public GetUsersOptions setIncludeServiceUsers(boolean includeServiceUsers)
public boolean isExtendedOutput()
public GetUsersOptions setExtendedOutput(boolean extendedOutput)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |