com.perforce.p4java.option.server
Class GetUsersOptions

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

public class GetUsersOptions
extends Options

Options class for server getUsers method.

See Also:

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 Recognized p4 users options; these include -mn, -l, and -a.

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

immutable, optionList, OPTPFX

Constructor Summary

GetUsersOptions()
Default constructor -- sets all fields to false or zero.

GetUsersOptions(int maxUsers)
Explicit-value constructor.

GetUsersOptions(int maxUsers, boolean includeServiceUsers, boolean extendedOutput)
Explicit-value constructor.

GetUsersOptions(String... options)
String-based constructor; possible values are: -mn.

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, 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 users options; these include -mn, -l, and -a.

See Also:

Constant Field Values

maxUsers

protected int maxUsers

If positive, return only the first maxUsers users. Corresponds to the -m flag.

includeServiceUsers

protected boolean includeServiceUsers

If true, include service users in the returned list; corresponds to the -a flag.

Since:

2011.1

extendedOutput

protected boolean extendedOutput

If true, include additional information in the output; corresponds to the -l flag.

Since:

2011.1

Constructor Detail

GetUsersOptions

public GetUsersOptions()

Default constructor -- sets all fields to false or zero.

GetUsersOptions

public GetUsersOptions(String... options)

String-based constructor; possible values are: -mn.

Parameters:

options - string options

GetUsersOptions

public GetUsersOptions(int maxUsers)

Explicit-value constructor.

GetUsersOptions

public GetUsersOptions(int maxUsers,
                       boolean includeServiceUsers,
                       boolean extendedOutput)

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)

getMaxUsers

public int getMaxUsers()

setMaxUsers

public GetUsersOptions setMaxUsers(int maxUsers)

isIncludeServiceUsers

public boolean isIncludeServiceUsers()

Since:

2011.1

setIncludeServiceUsers

public GetUsersOptions setIncludeServiceUsers(boolean includeServiceUsers)

Since:

2011.1

isExtendedOutput

public boolean isExtendedOutput()

Since:

2011.1

setExtendedOutput

public GetUsersOptions setExtendedOutput(boolean extendedOutput)

Since:

2011.1