public class MoveFileOptions extends Options
Modifier and Type | Field and Description |
---|---|
protected int |
changelistId
If not IChangelist.UNKNOWN, the files are opened in the numbered
pending changelist instead of the 'default' changelist.
|
protected java.lang.String |
fileType
If not null, the file is reopened as that filetype.
|
protected boolean |
force
If true, force a move to an existing target file;
the file must be synced and not opened.
|
protected boolean |
listOnly
If true, don't actually perform the move, just return what would
happen if the move was performed.
|
protected boolean |
noClientMove
if true, bypasses the client file rename.
|
static java.lang.String |
OPTIONS_SPECS
Options: -c[changelist], -n, -f, -t[type], -k
|
immutable, optionList
Constructor and Description |
---|
MoveFileOptions()
Default constructor.
|
MoveFileOptions(int changelistId,
boolean listOnly,
boolean force,
boolean noClientMove,
java.lang.String fileType)
Explicit-value constructor.
|
MoveFileOptions(java.lang.String... options)
Strings-based constructor; see 'p4 help [command]' for possible options.
|
Modifier and Type | Method and Description |
---|---|
int |
getChangelistId() |
java.lang.String |
getFileType() |
boolean |
isForce() |
boolean |
isListOnly() |
boolean |
isNoClientMove() |
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.
|
MoveFileOptions |
setChangelistId(int changelistId) |
MoveFileOptions |
setFileType(java.lang.String fileType) |
MoveFileOptions |
setForce(boolean force) |
MoveFileOptions |
setListOnly(boolean listOnly) |
MoveFileOptions |
setNoClientMove(boolean noClientMove) |
getOptions, isImmutable, processFields, setImmutable, setOptions
public static final java.lang.String OPTIONS_SPECS
protected int changelistId
protected boolean listOnly
protected boolean force
protected boolean noClientMove
protected java.lang.String fileType
public MoveFileOptions()
public MoveFileOptions(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 MoveFileOptions(int changelistId, boolean listOnly, boolean force, boolean noClientMove, java.lang.String fileType)
changelistId
- changelistIdlistOnly
- listOnlyforce
- forcenoClientMove
- noClientMovefileType
- fileTypepublic 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 MoveFileOptions setChangelistId(int changelistId)
public boolean isListOnly()
public MoveFileOptions setListOnly(boolean listOnly)
public boolean isForce()
public MoveFileOptions setForce(boolean force)
public boolean isNoClientMove()
public MoveFileOptions setNoClientMove(boolean noClientMove)
public java.lang.String getFileType()
public MoveFileOptions setFileType(java.lang.String fileType)