com.perforce.p4java.option.server
Class ChangelistOptions

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

public class ChangelistOptions
extends Options

Options class for IOptionsServer's getChangelist and deletePendingChangelist methods, and Changelist's update method.

See Also:

IOptionsServer.getChangelist(int, com.perforce.p4java.option.server.ChangelistOptions), IOptionsServer.deletePendingChangelist(int, com.perforce.p4java.option.server.ChangelistOptions), com.perforce.p4java.impl.generic.core.Changelist#update(com.perforce.p4java.option.server.ChangelistOptions)

Field Summary

protected boolean	force If true, force the update or deletion of other users' pending changelists.
protected boolean	forceUpdateByOwner If true, force the update of a submitted change by the owner of the change.
protected boolean	includeFixStatus If true, extend the list of jobs to include the fix status for each job.
static String	OPTIONS_SPECS Options: -s, -f, -u, -O
protected boolean	originalChangelist If true, specify that the changelist number is the original number of a changelist which was renamed on submit.

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

immutable, optionList, OPTPFX

Constructor Summary

ChangelistOptions()
Default constructor.

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

Method Summary

boolean	isForce()
boolean	isForceUpdateByOwner()
boolean	isIncludeFixStatus()
boolean	isOriginalChangelist()
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.
ChangelistOptions	setForce(boolean force)
ChangelistOptions	setForceUpdateByOwner(boolean forceUpdateByOwner)
ChangelistOptions	setIncludeFixStatus(boolean includeFixStatus)
ChangelistOptions	setOriginalChangelist(boolean originalChangelist)

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: -s, -f, -u, -O

See Also:

Constant Field Values

includeFixStatus

protected boolean includeFixStatus

If true, extend the list of jobs to include the fix status for each job. On new changelists, the fix status begins as the special status 'ignore', which, if left unchanged simply excludes the job from those being fixed. Otherwise, the fix status, like that applied with 'p4 fix -s', becomes the job's status when the changelist is committed. Note that this option exists to support integration with external defect trackers.

force

protected boolean force

If true, force the update or deletion of other users' pending changelists. The -f flag can also force the deletion of submitted changelists after they have been emptied of files using 'p4 obliterate'. By default, submitted changelists cannot be changed. The -f flag can also force display of the 'Description' field in a restricted changelist. Finally the -f flag can force changing the 'User' of an empty pending change via -U. The -f flag requires 'admin' access granted by 'p4 protect'. The -f and -u flags are mutually exclusive.

forceUpdateByOwner

protected boolean forceUpdateByOwner

If true, force the update of a submitted change by the owner of the change. Only the Jobs, Type, and Description fields can be changed using the -u flag. The -f and -u flags cannot be used in the same change command.

originalChangelist

protected boolean originalChangelist

If true, specify that the changelist number is the original number of a changelist which was renamed on submit. Corresponds to -O flag.

Constructor Detail

ChangelistOptions

public ChangelistOptions()

Default constructor.

ChangelistOptions

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

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)

isIncludeFixStatus

public boolean isIncludeFixStatus()

setIncludeFixStatus

public ChangelistOptions setIncludeFixStatus(boolean includeFixStatus)

isForce

public boolean isForce()

setForce

public ChangelistOptions setForce(boolean force)

isForceUpdateByOwner

public boolean isForceUpdateByOwner()

setForceUpdateByOwner

public ChangelistOptions setForceUpdateByOwner(boolean forceUpdateByOwner)

isOriginalChangelist

public boolean isOriginalChangelist()

setOriginalChangelist

public ChangelistOptions setOriginalChangelist(boolean originalChangelist)