com.perforce.p4java.option.server
Class GetStreamsOptions

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

public class GetStreamsOptions
extends Options

Options class for IOptionsServer.getStreams method.

See Also:

com.perforce.p4java.server.IOptionsServer#getStreams(java.lang.String, com.perforce.p4java.option.server.GetStreamsOptions)

Field Summary

protected String	fields The -T fields flag (used with tagged output) limits the fields output to those specified by a list given as 'fields'.
protected String	filter The -F filter flag limits the output to files satisfying the expression given as 'filter'.
protected int	maxResults If greater than zero, limit output to the first maxResults number of branches.
static String	OPTIONS_SPECS Options: -U -F["filter"], -T["fields"], -m[max]
protected boolean	unloaded If true, lists unloaded task streams (see 'p4 help unload').

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

immutable, optionList, OPTPFX

Constructor Summary

GetStreamsOptions()
Default constructor.

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

GetStreamsOptions(String filter, String fields, int maxResults)
Explicit-value constructor.

Method Summary

String	getFields()
String	getFilter()
int	getMaxResults()
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.
GetStreamsOptions	setFields(String fields)
GetStreamsOptions	setFilter(String filter)
GetStreamsOptions	setMaxResults(int maxResults)
GetStreamsOptions	setUnloaded(boolean unloaded)

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: -U -F["filter"], -T["fields"], -m[max]

See Also:

Constant Field Values

unloaded

protected boolean unloaded

If true, lists unloaded task streams (see 'p4 help unload'). Corresponds to -U flag.

filter

protected String filter

The -F filter flag limits the output to files satisfying the expression given as 'filter'. This filter expression is similar to the one used by 'jobs -e jobview', except that fields must match those above and are case sensitive.

e.g. -F "Parent=//Ace/MAIN & Type=development"

fields

protected String fields

The -T fields flag (used with tagged output) limits the fields output to those specified by a list given as 'fields'. These field names can be separated by a space or a comma.

e.g. -T "Stream, Owner"

maxResults

protected int maxResults

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

Constructor Detail

GetStreamsOptions

public GetStreamsOptions()

Default constructor.

GetStreamsOptions

public GetStreamsOptions(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...)

GetStreamsOptions

public GetStreamsOptions(String filter,
                         String fields,
                         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)

isUnloaded

public boolean isUnloaded()

setUnloaded

public GetStreamsOptions setUnloaded(boolean unloaded)

getFilter

public String getFilter()

setFilter

public GetStreamsOptions setFilter(String filter)

getFields

public String getFields()

setFields

public GetStreamsOptions setFields(String fields)

getMaxResults

public int getMaxResults()

setMaxResults

public GetStreamsOptions setMaxResults(int maxResults)