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 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 String	nameFilter If non-null, limits output to clients whose name matches the nameFilter pattern.
static 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 String	stream If non-null, limits output to the client workspaces dedicated to the stream.
protected boolean	unloaded If true, lists unloaded clients.
protected String	userName If non-null, limit qualifying clients to those owned by the named user.

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

immutable, optionList, OPTPFX

Constructor Summary

GetClientsOptions()
Default constructor.

GetClientsOptions(boolean showTime, String userName, String caseInsensitiveNameFilter, int maxResults, String stream)
Explicit-value constructor.

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

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

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

GetClientsOptions(String... options)
Strings-based constructor; see 'p4 help [command]' for possible options.

Method Summary

String	getCaseInsensitiveNameFilter()
int	getMaxResults()
String	getNameFilter()
String	getStream()
String	getUserName()
boolean	isShowTime()
boolean	isUnloaded()
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	setCaseInsensitiveNameFilter(String caseInsensitiveNameFilter)
GetClientsOptions	setMaxResults(int maxResults)
GetClientsOptions	setNameFilter(String nameFilter)
GetClientsOptions	setShowTime(boolean showTime)
GetClientsOptions	setStream(String stream)
GetClientsOptions	setUnloaded(boolean unloaded)
GetClientsOptions	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

OPTIONS_SPECS

public static final String OPTIONS_SPECS

Options: -m[max], -u[user], -e[nameFilter], -E[nameFilter], -t, -S[stream]

Options: -U

See Also:

Constant Field Values

userName

protected String userName

If non-null, limit qualifying clients to those owned by the named user. Corresponds to -uname flag.

nameFilter

protected String nameFilter

If non-null, limits output to clients whose name matches the nameFilter pattern. Corresponds to -enameFilter flag

caseInsensitiveNameFilter

protected String caseInsensitiveNameFilter

If non-null, limits output to clients whose name matches (case-insensitive) the nameFilter pattern. Corresponds to -EnameFilter flag

maxResults

protected int maxResults

If greater than zero, limit output to the first maxResults number of clients. Corresponds to -m flag.

showTime

protected boolean showTime

If true, displays the time as well as the date. Corresponds to -t flag.

stream

protected String stream

If non-null, limits output to the client workspaces dedicated to the stream. Corresponds to the "-S stream" flag.

unloaded

protected boolean unloaded

If true, lists unloaded clients. Corresponds to -U flag.

Constructor Detail

GetClientsOptions

public GetClientsOptions()

Default constructor.

GetClientsOptions

public GetClientsOptions(String... options)

Strings-based constructor; see 'p4 help [command]' for possible 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.

See Also:

Options.Options(java.lang.String...)

GetClientsOptions

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

Explicit-value constructor.

GetClientsOptions

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

Explicit-value constructor.

GetClientsOptions

public GetClientsOptions(int maxResults,
                         String userName,
                         String nameFilter,
                         boolean showTime,
                         String stream)

Explicit-value constructor.

GetClientsOptions

public GetClientsOptions(boolean showTime,
                         String userName,
                         String caseInsensitiveNameFilter,
                         int maxResults,
                         String stream)

Explicit-value constructor.

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)

getCaseInsensitiveNameFilter

public String getCaseInsensitiveNameFilter()

setCaseInsensitiveNameFilter

public GetClientsOptions setCaseInsensitiveNameFilter(String caseInsensitiveNameFilter)

isShowTime

public boolean isShowTime()

setShowTime

public GetClientsOptions setShowTime(boolean showTime)

getStream

public String getStream()

setStream

public GetClientsOptions setStream(String stream)

isUnloaded

public boolean isUnloaded()

setUnloaded

public GetClientsOptions setUnloaded(boolean unloaded)