com.perforce.p4java.option.client
Class ReconcileFilesOptions

java.lang.Object
  com.perforce.p4java.option.Options
      com.perforce.p4java.option.client.ReconcileFilesOptions

public class ReconcileFilesOptions
extends Options

IClient reconcileFiles method Options definitions.

See Also:

com.perforce.p4java.client.IClient#addFiles(java.util.List, com.perforce.p4java.option.client.ReconcileFilesOptions)

Field Summary

protected int	changelistId If positive, the opened files are put into the pending changelist identified by changelistId (this changelist must have been previously created for this to succeed).
protected boolean	checkModTime If true, used in conjunction with '-e' can be used to minimize costly digest computation on the client by checking file modification times before checking digests to determine if files have been modified outside of Perforce.
protected boolean	localSyntax If true, requests output in local file syntax using relative paths, similar to the workspace-centric view provided by 'status'.
protected boolean	noIgnoreChecking If true, informs the client that it should not perform any ignore checking.
protected boolean	noUpdate If true, don't actually do the add, just return the files that would have been opened for addition.
static String	OPTIONS_SPECS Options: -n, -c[changelist], -e, -a, -f, -I, -d, -l, -m, -w
protected boolean	outsideAdd If true, allows the user to reconcile files that are in the user's directory that are not under Perforce source control.
protected boolean	outsideEdit If true, allows the user to reconcile files that have been modified outside of Perforce.
protected boolean	removed If true, allows the user to reconcile files that have been removed from the user's directory but are still in the depot.
protected boolean	updateWorkspace If true, forces the workspace files to be updated to match the depot rather than opening them so that the depot can be updated to match the workspace.
protected boolean	useWildcards If true, filenames that contain wildcards are permitted.

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

immutable, optionList, OPTPFX

Constructor Summary

ReconcileFilesOptions()
Default constructor.

ReconcileFilesOptions(boolean noUpdate, int changelistId, boolean outsideEdit, boolean outsideAdd, boolean useWildcards, boolean noIgnoreChecking, boolean removed, boolean localSyntax)
Explicit-value constructor.

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

Method Summary

int	getChangelistId()
boolean	getOutsideAdd()
boolean	getOutsideEdit()
boolean	isCheckModTime()
boolean	isLocalSyntax()
boolean	isNoIgnoreChecking()
boolean	isNoUpdate()
boolean	isRemoved()
boolean	isUpdateWorkspace()
boolean	isUseWildcards()
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.
ReconcileFilesOptions	setChangelistId(int changelistId)
ReconcileFilesOptions	setCheckModTime(boolean checkModTime)
ReconcileFilesOptions	setLocalSyntax(boolean localSyntax)
ReconcileFilesOptions	setNoIgnoreChecking(boolean noIgnoreChecking)
ReconcileFilesOptions	setNoUpdate(boolean noUpdate)
ReconcileFilesOptions	setOutsideAdd(boolean outsideAdd)
ReconcileFilesOptions	setOutsideEdit(boolean outsideEdit)
ReconcileFilesOptions	setRemoved(boolean removed)
ReconcileFilesOptions	setUpdateWorkspace(boolean updateWorkspace)
ReconcileFilesOptions	setUseWildcards(boolean useWildcards)

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: -n, -c[changelist], -e, -a, -f, -I, -d, -l, -m, -w

See Also:

Constant Field Values

noUpdate

protected boolean noUpdate

If true, don't actually do the add, just return the files that would have been opened for addition. Corresponds to the '-n' flag.

changelistId

protected int changelistId

If positive, the opened files are put into the pending changelist identified by changelistId (this changelist must have been previously created for this to succeed). If zero or negative, the file is opened in the 'default' (unnumbered) changelist. Corresponds to the '-c changelist#' flag.

outsideEdit

protected boolean outsideEdit

If true, allows the user to reconcile files that have been modified outside of Perforce. The reconcile command will open these files for edit. Corresponds to the '-e' flag.

outsideAdd

protected boolean outsideAdd

If true, allows the user to reconcile files that are in the user's directory that are not under Perforce source control. These files are opened for add. Corresponds to the '-a' flag.

useWildcards

protected boolean useWildcards

If true, filenames that contain wildcards are permitted. See the main Perforce documentation for file adding for details. Corresponds to the '-f' flag.

noIgnoreChecking

protected boolean noIgnoreChecking

If true, informs the client that it should not perform any ignore checking. Corresponds to the '-I' flag

removed

protected boolean removed

If true, allows the user to reconcile files that have been removed from the user's directory but are still in the depot. These files will be opened for delete only if they are still on the user's have list. Corresponds to the '-d' flag.

localSyntax

protected boolean localSyntax

If true, requests output in local file syntax using relative paths, similar to the workspace-centric view provided by 'status'. Corresponds to the '-l' flag.

checkModTime

protected boolean checkModTime

If true, used in conjunction with '-e' can be used to minimize costly digest computation on the client by checking file modification times before checking digests to determine if files have been modified outside of Perforce. Corresponds to the '-m' flag.

updateWorkspace

protected boolean updateWorkspace

If true, forces the workspace files to be updated to match the depot rather than opening them so that the depot can be updated to match the workspace. Files that are not under source control will be deleted, and modified or deleted files will be refreshed. Note that this operation will result in the loss of any changes made to unopened files. This option requires read permission. Corresponds to the '-w' flag.

Constructor Detail

ReconcileFilesOptions

public ReconcileFilesOptions()

Default constructor.

ReconcileFilesOptions

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

ReconcileFilesOptions

public ReconcileFilesOptions(boolean noUpdate,
                             int changelistId,
                             boolean outsideEdit,
                             boolean outsideAdd,
                             boolean useWildcards,
                             boolean noIgnoreChecking,
                             boolean removed,
                             boolean localSyntax)

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)

isNoUpdate

public boolean isNoUpdate()

setNoUpdate

public ReconcileFilesOptions setNoUpdate(boolean noUpdate)

getChangelistId

public int getChangelistId()

setChangelistId

public ReconcileFilesOptions setChangelistId(int changelistId)

getOutsideEdit

public boolean getOutsideEdit()

setOutsideEdit

public ReconcileFilesOptions setOutsideEdit(boolean outsideEdit)

getOutsideAdd

public boolean getOutsideAdd()

setOutsideAdd

public ReconcileFilesOptions setOutsideAdd(boolean outsideAdd)

isUseWildcards

public boolean isUseWildcards()

setUseWildcards

public ReconcileFilesOptions setUseWildcards(boolean useWildcards)

isNoIgnoreChecking

public boolean isNoIgnoreChecking()

setNoIgnoreChecking

public ReconcileFilesOptions setNoIgnoreChecking(boolean noIgnoreChecking)

isRemoved

public boolean isRemoved()

setRemoved

public ReconcileFilesOptions setRemoved(boolean removed)

isLocalSyntax

public boolean isLocalSyntax()

setLocalSyntax

public ReconcileFilesOptions setLocalSyntax(boolean localSyntax)

isCheckModTime

public boolean isCheckModTime()

setCheckModTime

public ReconcileFilesOptions setCheckModTime(boolean checkModTime)

isUpdateWorkspace

public boolean isUpdateWorkspace()

setUpdateWorkspace

public ReconcileFilesOptions setUpdateWorkspace(boolean updateWorkspace)