com.perforce.p4java.option.client
Class CopyFilesOptions

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

public class CopyFilesOptions
extends Options

Options class for the IClient copyFiles method.

Recognized options: -cn -n -v -s -r

Since:

2011.1

Field Summary

protected boolean	bidirectional If true, this is a 'bidirectional' copy.
protected int	changelistId If positive, use the changelistId given instead of the default changelist.
protected boolean	noClientSyncOrMod If true, don't do syncing or modifying of client files.
protected boolean	noUpdate If true, don't actually do the copy.
static String	OPTIONS_SPECS Recognized p4 copy options; these include -cn, -n, -v, -s, -r.
protected boolean	reverseMapping Reverse the mappings in the branch view, with the target files and source files exchanging place.

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

immutable, optionList, OPTPFX

Constructor Summary

CopyFilesOptions()
Default constructor.

CopyFilesOptions(int changelistId, boolean noUpdate, boolean noClientSyncOrMod)
Explicit-value constructor.

CopyFilesOptions(int changelistId, boolean noUpdate, boolean noClientSyncOrMod, boolean bidirectional)
Explicit-value constructor.

CopyFilesOptions(int changelistId, boolean noUpdate, boolean noClientSyncOrMod, boolean bidirectional, boolean reverseMapping)
Explicit-value constructor.

CopyFilesOptions(String... options)
String-based constructor; possible valid values are: -cn, -v, -n, -s, -r.

Method Summary

int	getChangelistId()
boolean	isBidirectional()
boolean	isNoClientSyncOrMod()
boolean	isNoUpdate()
boolean	isReverseMapping()
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.
CopyFilesOptions	setBidirectional(boolean bidirectional)
CopyFilesOptions	setChangelistId(int changelistId)
CopyFilesOptions	setNoClientSyncOrMod(boolean noClientSyncOrMod)
CopyFilesOptions	setNoUpdate(boolean noUpdate)
CopyFilesOptions	setReverseMapping(boolean reverseMapping)

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 copy options; these include -cn, -n, -v, -s, -r.

See Also:

Constant Field Values

changelistId

protected int changelistId

If positive, use the changelistId given instead of the default changelist. Corresponds to the -c option.

noUpdate

protected boolean noUpdate

If true, don't actually do the copy. Corresponds to -n flag.

noClientSyncOrMod

protected boolean noClientSyncOrMod

If true, don't do syncing or modifying of client files. Corresponds to -v flag.

bidirectional

protected boolean bidirectional

If true, this is a 'bidirectional' copy. Corresponds to -s flag.

reverseMapping

protected boolean reverseMapping

Reverse the mappings in the branch view, with the target files and source files exchanging place. Corresponds to the -r flag.

Constructor Detail

CopyFilesOptions

public CopyFilesOptions()

Default constructor. All fields set to false or IChangelist.UNKOWN.

CopyFilesOptions

public CopyFilesOptions(String... options)

String-based constructor; possible valid values are: -cn, -v, -n, -s, -r.

Parameters:

options - string options

CopyFilesOptions

public CopyFilesOptions(int changelistId,
                        boolean noUpdate,
                        boolean noClientSyncOrMod)

Explicit-value constructor.

CopyFilesOptions

public CopyFilesOptions(int changelistId,
                        boolean noUpdate,
                        boolean noClientSyncOrMod,
                        boolean bidirectional)

Explicit-value constructor.

CopyFilesOptions

public CopyFilesOptions(int changelistId,
                        boolean noUpdate,
                        boolean noClientSyncOrMod,
                        boolean bidirectional,
                        boolean reverseMapping)

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 CopyFilesOptions setChangelistId(int changelistId)

isNoUpdate

public boolean isNoUpdate()

setNoUpdate

public CopyFilesOptions setNoUpdate(boolean noUpdate)

isNoClientSyncOrMod

public boolean isNoClientSyncOrMod()

setNoClientSyncOrMod

public CopyFilesOptions setNoClientSyncOrMod(boolean noClientSyncOrMod)

isBidirectional

public boolean isBidirectional()

setBidirectional

public CopyFilesOptions setBidirectional(boolean bidirectional)

isReverseMapping

public boolean isReverseMapping()

setReverseMapping

public CopyFilesOptions setReverseMapping(boolean reverseMapping)