com.perforce.p4java.option.server
Class GetClientsOptions

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

public class GetClientsOptions
extends Options

Options class for the server's getClients method.

See Also:

IOptionsServer.getClients(com.perforce.p4java.option.server.GetClientsOptions)

Field Summary

protected int	maxResults
protected String	nameFilter
static String	OPTIONS_SPECS Recognized p4 clients options; these include -mmax, -uuser, -enameFilter.
protected String	userName

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

immutable, optionList, OPTPFX

Constructor Summary

GetClientsOptions()
Default constructor; sets all fields to null, zero, or false.

GetClientsOptions(int maxResults, String userName, String nameFilter)
Explicit-value constructor.

GetClientsOptions(String... options)
String-based constructor; possible values are: -mmax, -uuser, -enameFilter.

Method Summary

int	getMaxResults()
String	getNameFilter()
String	getUserName()
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.
GetClientsOptions	setMaxResults(int maxResults)
GetClientsOptions	setNameFilter(String nameFilter)
GetClientsOptions	setUserName(String userName)

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 clients options; these include -mmax, -uuser, -enameFilter.

See Also:

Constant Field Values

maxResults

protected int maxResults

userName

protected String userName

nameFilter

protected String nameFilter

Constructor Detail

GetClientsOptions

public GetClientsOptions()

Default constructor; sets all fields to null, zero, or false.

GetClientsOptions

public GetClientsOptions(int maxResults,
                         String userName,
                         String nameFilter)

Explicit-value constructor.

GetClientsOptions

public GetClientsOptions(String... options)

String-based constructor; possible values are: -mmax, -uuser, -enameFilter.

Parameters:

options - string options

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)

getMaxResults

public int getMaxResults()

setMaxResults

public GetClientsOptions setMaxResults(int maxResults)

getUserName

public String getUserName()

setUserName

public GetClientsOptions setUserName(String userName)

getNameFilter

public String getNameFilter()

setNameFilter

public GetClientsOptions setNameFilter(String nameFilter)