Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.perforce.p4java.option.server
Class MoveFileOptions

java.lang.Object
  extended by com.perforce.p4java.option.Options
      extended by com.perforce.p4java.option.server.MoveFileOptions

public class MoveFileOptions
extends Options

Options class for IOptionsServer moveFile method.

See Also:
IOptionsServer.moveFile(com.perforce.p4java.core.file.IFileSpec, com.perforce.p4java.core.file.IFileSpec, com.perforce.p4java.option.server.MoveFileOptions)

Field Summary
protected  int changelistId
          If not IChangelist.UNKNOWN, the files are opened in the numbered pending changelist instead of the 'default' changelist.
protected  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 String OPTIONS_SPECS
          Options: -c[changelist], -n, -f, -t[type], -k
 
Fields inherited from class com.perforce.p4java.option.Options
immutable, optionList, OPTPFX
 
Constructor Summary
MoveFileOptions()
          Default constructor.
MoveFileOptions(int changelistId, boolean listOnly, boolean force, boolean noClientMove, String fileType)
          Explicit-value constructor.
MoveFileOptions(String... options)
          Strings-based constructor; see 'p4 help [command]' for possible options.
 
Method Summary
 int getChangelistId()
           
 String getFileType()
           
 boolean isForce()
           
 boolean isListOnly()
           
 boolean isNoClientMove()
           
 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.
 MoveFileOptions setChangelistId(int changelistId)
           
 MoveFileOptions setFileType(String fileType)
           
 MoveFileOptions setForce(boolean force)
           
 MoveFileOptions setListOnly(boolean listOnly)
           
 MoveFileOptions setNoClientMove(boolean noClientMove)
           
 
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: -c[changelist], -n, -f, -t[type], -k

See Also:
Constant Field Values

changelistId

protected int changelistId
If not IChangelist.UNKNOWN, the files are opened in the numbered pending changelist instead of the 'default' changelist. Corresponds to the -c flag.

listOnly

protected boolean listOnly
If true, don't actually perform the move, just return what would happen if the move was performed. Corresponds to the -n flag.

force

protected boolean force
If true, force a move to an existing target file; the file must be synced and not opened. Note that the originating source file will no longer be synced to the client. Corresponds to the -f flag.

noClientMove

protected boolean noClientMove
if true, bypasses the client file rename. This option can be used to tell the server that the user has already renamed a file on the client. The use of this option can confuse the server if you are wrong about the client's contents. Only works for 2009.2 and later servers; earlier servers will produce a RequestException if you set this true. Corresponds to the -k flag.

fileType

protected String fileType
If not null, the file is reopened as that filetype. Corresponds to the -t flag.

Constructor Detail

MoveFileOptions

public MoveFileOptions()
Default constructor.

MoveFileOptions

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

MoveFileOptions

public MoveFileOptions(int changelistId,
                       boolean listOnly,
                       boolean force,
                       boolean noClientMove,
                       String fileType)
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 MoveFileOptions setChangelistId(int changelistId)

isListOnly

public boolean isListOnly()

setListOnly

public MoveFileOptions setListOnly(boolean listOnly)

isForce

public boolean isForce()

setForce

public MoveFileOptions setForce(boolean force)

isNoClientMove

public boolean isNoClientMove()

setNoClientMove

public MoveFileOptions setNoClientMove(boolean noClientMove)

getFileType

public String getFileType()

setFileType

public MoveFileOptions setFileType(String fileType)
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2015 Perforce Software. All Rights Reserved.