com.perforce.p4java.option.server
Class GetBranchSpecsOptions

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

public class GetBranchSpecsOptions
extends Options

Options class for IOptionsServer.getBranchSpecs method.

See Also:

IOptionsServer.getBranchSpecs(com.perforce.p4java.option.server.GetBranchSpecsOptions)

Field Summary

protected int	maxResults If greater than zero, limit output to the first maxResults number of branches.
protected String	nameFilter If non-null, limits output to branches whose name matches the nameFilter pattern.
static String	OPTIONS_SPECS Recognized p4 options; these include -uuser -enameFilter -mmax.
protected String	userName If non-null, limit qualifying branches to those owned by the named user.

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

immutable, optionList, OPTPFX

Constructor Summary

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

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

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

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.
GetBranchSpecsOptions	setMaxResults(int maxResults)
GetBranchSpecsOptions	setNameFilter(String nameFilter)
GetBranchSpecsOptions	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 options; these include -uuser -enameFilter -mmax.

See Also:

Constant Field Values

userName

protected String userName

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

nameFilter

protected String nameFilter

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

maxResults

protected int maxResults

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

Constructor Detail

GetBranchSpecsOptions

public GetBranchSpecsOptions()

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

GetBranchSpecsOptions

public GetBranchSpecsOptions(String... options)

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

Parameters:

options - string options

GetBranchSpecsOptions

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

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)

getUserName

public String getUserName()

setUserName

public GetBranchSpecsOptions setUserName(String userName)

getNameFilter

public String getNameFilter()

setNameFilter

public GetBranchSpecsOptions setNameFilter(String nameFilter)

getMaxResults

public int getMaxResults()

setMaxResults

public GetBranchSpecsOptions setMaxResults(int maxResults)