com.perforce.p4java.option.server
Class GetReviewChangelistsOptions

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

public class GetReviewChangelistsOptions
extends Options

Options class for the IOptionsServer.getReviewChangelists method.

See Also:

IOptionsServer.getReviewChangelists(com.perforce.p4java.option.server.GetReviewChangelistsOptions)

Field Summary

protected int	changelistId If greater than zero, lists changelists that have not been reviewed before, equal or above the specified changelist#.
protected String	counter If not null, lists changelists that have not been reviewed before, above the specified counter's changelist#.
static String	OPTIONS_SPECS Options: -c[changelist], -t[counter]

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

immutable, optionList, OPTPFX

Constructor Summary

GetReviewChangelistsOptions()
Default constructor.

GetReviewChangelistsOptions(int changelistId, String counter)
Explicit-value constructor.

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

Method Summary

int	getChangelistId()
String	getCounter()
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.
GetReviewChangelistsOptions	setChangelistId(int changelistId)
GetReviewChangelistsOptions	setCounter(String counter)

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: -c[changelist], -t[counter]

See Also:

Constant Field Values

changelistId

protected int changelistId

If greater than zero, lists changelists that have not been reviewed before, equal or above the specified changelist#. Corresponds to -c changelist#.

counter

protected String counter

If not null, lists changelists that have not been reviewed before, above the specified counter's changelist#.

Note, if both the 'changelistId' and 'counter' options are specified, the 'p4 review' sets the counter to that changelist# and produces no output. This functionality has been superceded by the 'p4 counter' command. Corresponds to -t counter.

Constructor Detail

GetReviewChangelistsOptions

public GetReviewChangelistsOptions()

Default constructor.

GetReviewChangelistsOptions

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

GetReviewChangelistsOptions

public GetReviewChangelistsOptions(int changelistId,
                                   String counter)

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)

getChangelistId

public int getChangelistId()

setChangelistId

public GetReviewChangelistsOptions setChangelistId(int changelistId)

getCounter

public String getCounter()

setCounter

public GetReviewChangelistsOptions setCounter(String counter)