Package 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.

Since:

2011.1

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	bidirectional	If true, this is a 'bidirectional' copy.
protected java.lang.String	branch	If non-null, use a user-defined branch view.
protected int	changelistId	If positive, use the changelistId given instead of the default changelist.
protected boolean	force	If true, force the creation of extra revisions in order to explicitly record that files have been copied.
protected boolean	forceStreamCopy	If true, used with -S to force copying even though the stream does not expect a copy to occur in the direction indicated.
protected int	maxFiles	If positive, copy only the first maxFiles files.
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 java.lang.String	OPTIONS_SPECS	Options: -c[changelist], -f, -n, -q, -v, -b[branch], -S[stream], -P[parentStream], -F, -r, -s
protected java.lang.String	parentStream	If non-null, specify a parent stream other than the stream's actual parent.
protected boolean	quiet	If true, suppresses normal output messages.
protected boolean	reverseMapping	Reverse the mappings in the branch view, with the target files and source files exchanging place.
protected java.lang.String	stream	If non-null, use this stream's branch view.

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

immutable, optionList

Constructor Summary

Constructors

Constructor	Description
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(int changelistId, boolean noUpdate, boolean noClientSyncOrMod, boolean bidirectional, boolean reverseMapping, int maxFiles)	Explicit-value constructor.
CopyFilesOptions(int changelistId, boolean noUpdate, boolean noClientSyncOrMod, int maxFiles, java.lang.String branch, boolean reverseMapping, boolean bidirectional)	Explicit-value constructor for use with a branch.
CopyFilesOptions(int changelistId, boolean noUpdate, boolean noClientSyncOrMod, int maxFiles, java.lang.String stream, java.lang.String parentStream, boolean forceStreamCopy, boolean reverseMapping)	Explicit-value constructor for use with a stream.
CopyFilesOptions(java.lang.String... options)	Strings-based constructor; see 'p4 help [command]' for possible options.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getBranch()
int	getChangelistId()
int	getMaxFiles()
java.lang.String	getParentStream()
java.lang.String	getStream()
boolean	isBidirectional()
boolean	isForce()
boolean	isForceStreamCopy()
boolean	isNoClientSyncOrMod()
boolean	isNoUpdate()
boolean	isQuiet()
boolean	isReverseMapping()
java.util.List<java.lang.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	setBranch(java.lang.String branch)
CopyFilesOptions	setChangelistId(int changelistId)
CopyFilesOptions	setForce(boolean force)
CopyFilesOptions	setForceStreamCopy(boolean forceStreamCopy)
CopyFilesOptions	setMaxFiles(int maxFiles)
CopyFilesOptions	setNoClientSyncOrMod(boolean noClientSyncOrMod)
CopyFilesOptions	setNoUpdate(boolean noUpdate)
CopyFilesOptions	setParentStream(java.lang.String parentStream)
CopyFilesOptions	setQuiet(boolean quiet)
CopyFilesOptions	setReverseMapping(boolean reverseMapping)
CopyFilesOptions	setStream(java.lang.String stream)

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

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 java.lang.String OPTIONS_SPECS

Options: -c[changelist], -f, -n, -q, -v, -b[branch], -S[stream], -P[parentStream], -F, -r, -s

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.

force

protected boolean force

If true, force the creation of extra revisions in order to explicitly record that files have been copied. Corresponds to -f flag.

noUpdate

protected boolean noUpdate

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

quiet

protected boolean quiet

If true, suppresses normal output messages. Messages regarding errors or exceptional conditions are not suppressed. Corresponds to -q 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.

maxFiles

protected int maxFiles

If positive, copy only the first maxFiles files. Corresponds to -m flag.

branch

protected java.lang.String branch

If non-null, use a user-defined branch view. The source is the left side of the branch view and the target is the right side. With -r, the direction is reversed. Corresponds to -b flag.

stream

protected java.lang.String stream

If non-null, use this stream's branch view. The source is the stream itself, and the target is the stream's parent. With -r, the direction is reversed. -P can be used to specify a parent stream other than the stream's actual parent. Note that to submit copied stream files, the current client must be dedicated to the target stream. Corresponds to -S flag.

parentStream

protected java.lang.String parentStream

If non-null, specify a parent stream other than the stream's actual parent. Corresponds to -P flag.

forceStreamCopy

protected boolean forceStreamCopy

If true, used with -S to force copying even though the stream does not expect a copy to occur in the direction indicated. Normally 'p4 copy' enforces the expected flow of change dictated by the stream's spec. The 'p4 istat' command summarizes a stream's expected flow of change. Corresponds to -F flag.

Constructor Detail

CopyFilesOptions

public CopyFilesOptions()

Default constructor.

CopyFilesOptions

public CopyFilesOptions(java.lang.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.

Parameters:

options - options

See Also:

Options(java.lang.String...)

CopyFilesOptions

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

Explicit-value constructor.

Parameters:

changelistId - changelistId

noUpdate - noUpdate

noClientSyncOrMod - noClientSyncOrMod

CopyFilesOptions

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

Explicit-value constructor.

Parameters:

changelistId - changelistId

noUpdate - noUpdate

noClientSyncOrMod - noClientSyncOrMod

bidirectional - bidirectional

CopyFilesOptions

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

Explicit-value constructor.

Parameters:

changelistId - changelistId

noUpdate - noUpdate

noClientSyncOrMod - noClientSyncOrMod

bidirectional - bidirectional

reverseMapping - reverseMapping

CopyFilesOptions

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

Explicit-value constructor.

Parameters:

changelistId - changelistId

noUpdate - noUpdate

noClientSyncOrMod - noClientSyncOrMod

bidirectional - bidirectional

reverseMapping - reverseMapping

maxFiles - maxFiles

CopyFilesOptions

public CopyFilesOptions(int changelistId,
                        boolean noUpdate,
                        boolean noClientSyncOrMod,
                        int maxFiles,
                        java.lang.String branch,
                        boolean reverseMapping,
                        boolean bidirectional)

Explicit-value constructor for use with a branch.

Parameters:

changelistId - changelistId

noUpdate - noUpdate

noClientSyncOrMod - noClientSyncOrMod

maxFiles - maxFiles

branch - branch

reverseMapping - reverseMapping

bidirectional - bidirectional

CopyFilesOptions

public CopyFilesOptions(int changelistId,
                        boolean noUpdate,
                        boolean noClientSyncOrMod,
                        int maxFiles,
                        java.lang.String stream,
                        java.lang.String parentStream,
                        boolean forceStreamCopy,
                        boolean reverseMapping)

Explicit-value constructor for use with a stream.

Parameters:

changelistId - changelistId

noUpdate - noUpdate

noClientSyncOrMod - noClientSyncOrMod

maxFiles - maxFiles

stream - stream

parentStream - parentStream

forceStreamCopy - forceStreamCopy

reverseMapping - reverseMapping

Method Detail

processOptions

public java.util.List<java.lang.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)

isForce

public boolean isForce()

setForce

public CopyFilesOptions setForce(boolean force)

isNoUpdate

public boolean isNoUpdate()

setNoUpdate

public CopyFilesOptions setNoUpdate(boolean noUpdate)

isQuiet

public boolean isQuiet()

setQuiet

public CopyFilesOptions setQuiet(boolean quiet)

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)

getMaxFiles

public int getMaxFiles()

setMaxFiles

public CopyFilesOptions setMaxFiles(int maxFiles)

getBranch

public java.lang.String getBranch()

setBranch

public CopyFilesOptions setBranch(java.lang.String branch)

getStream

public java.lang.String getStream()

setStream

public CopyFilesOptions setStream(java.lang.String stream)

getParentStream

public java.lang.String getParentStream()

setParentStream

public CopyFilesOptions setParentStream(java.lang.String parentStream)

isForceStreamCopy

public boolean isForceStreamCopy()

setForceStreamCopy

public CopyFilesOptions setForceStreamCopy(boolean forceStreamCopy)