public class CopyFilesOptions extends Options
Modifier and Type | Field and 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.
|
immutable, optionList
Constructor and 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.
|
Modifier and Type | Method and 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) |
getOptions, isImmutable, processFields, setImmutable, setOptions
public static final java.lang.String OPTIONS_SPECS
protected int changelistId
protected boolean force
protected boolean noUpdate
protected boolean quiet
protected boolean noClientSyncOrMod
protected boolean bidirectional
protected boolean reverseMapping
protected int maxFiles
protected java.lang.String branch
protected java.lang.String stream
protected java.lang.String parentStream
protected boolean forceStreamCopy
public CopyFilesOptions()
public CopyFilesOptions(java.lang.String... 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.
options
- optionsOptions(java.lang.String...)
public CopyFilesOptions(int changelistId, boolean noUpdate, boolean noClientSyncOrMod)
changelistId
- changelistIdnoUpdate
- noUpdatenoClientSyncOrMod
- noClientSyncOrModpublic CopyFilesOptions(int changelistId, boolean noUpdate, boolean noClientSyncOrMod, boolean bidirectional)
changelistId
- changelistIdnoUpdate
- noUpdatenoClientSyncOrMod
- noClientSyncOrModbidirectional
- bidirectionalpublic CopyFilesOptions(int changelistId, boolean noUpdate, boolean noClientSyncOrMod, boolean bidirectional, boolean reverseMapping)
changelistId
- changelistIdnoUpdate
- noUpdatenoClientSyncOrMod
- noClientSyncOrModbidirectional
- bidirectionalreverseMapping
- reverseMappingpublic CopyFilesOptions(int changelistId, boolean noUpdate, boolean noClientSyncOrMod, boolean bidirectional, boolean reverseMapping, int maxFiles)
changelistId
- changelistIdnoUpdate
- noUpdatenoClientSyncOrMod
- noClientSyncOrModbidirectional
- bidirectionalreverseMapping
- reverseMappingmaxFiles
- maxFilespublic CopyFilesOptions(int changelistId, boolean noUpdate, boolean noClientSyncOrMod, int maxFiles, java.lang.String branch, boolean reverseMapping, boolean bidirectional)
changelistId
- changelistIdnoUpdate
- noUpdatenoClientSyncOrMod
- noClientSyncOrModmaxFiles
- maxFilesbranch
- branchreverseMapping
- reverseMappingbidirectional
- bidirectionalpublic CopyFilesOptions(int changelistId, boolean noUpdate, boolean noClientSyncOrMod, int maxFiles, java.lang.String stream, java.lang.String parentStream, boolean forceStreamCopy, boolean reverseMapping)
changelistId
- changelistIdnoUpdate
- noUpdatenoClientSyncOrMod
- noClientSyncOrModmaxFiles
- maxFilesstream
- streamparentStream
- parentStreamforceStreamCopy
- forceStreamCopyreverseMapping
- reverseMappingpublic java.util.List<java.lang.String> processOptions(IServer server) throws OptionsException
Options
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.
processOptions
in class Options
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...OptionsException
- if an error occurs in options processing that is not some
species of ConnectionException, RequestException,
AccessException, etc.Options.processOptions(com.perforce.p4java.server.IServer)
public int getChangelistId()
public CopyFilesOptions setChangelistId(int changelistId)
public boolean isForce()
public CopyFilesOptions setForce(boolean force)
public boolean isNoUpdate()
public CopyFilesOptions setNoUpdate(boolean noUpdate)
public boolean isQuiet()
public CopyFilesOptions setQuiet(boolean quiet)
public boolean isNoClientSyncOrMod()
public CopyFilesOptions setNoClientSyncOrMod(boolean noClientSyncOrMod)
public boolean isBidirectional()
public CopyFilesOptions setBidirectional(boolean bidirectional)
public boolean isReverseMapping()
public CopyFilesOptions setReverseMapping(boolean reverseMapping)
public int getMaxFiles()
public CopyFilesOptions setMaxFiles(int maxFiles)
public java.lang.String getBranch()
public CopyFilesOptions setBranch(java.lang.String branch)
public java.lang.String getStream()
public CopyFilesOptions setStream(java.lang.String stream)
public java.lang.String getParentStream()
public CopyFilesOptions setParentStream(java.lang.String parentStream)
public boolean isForceStreamCopy()
public CopyFilesOptions setForceStreamCopy(boolean forceStreamCopy)