Package com.perforce.p4java.option.server

Class MoveFileOptions

    • Field Detail

      • OPTIONS_SPECS

        public static final java.lang.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 java.lang.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​(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...)

      • MoveFileOptions

        public MoveFileOptions​(int changelistId,
                       boolean listOnly,
                       boolean force,
                       boolean noClientMove,
                       java.lang.String fileType)
        Explicit-value constructor.
        Parameters:
        changelistId - changelistId
        listOnly - listOnly
        force - force
        noClientMove - noClientMove
        fileType - fileType

    • 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 MoveFileOptions setChangelistId​(int changelistId)

      • isListOnly

        public boolean isListOnly()

      • isForce

        public boolean isForce()

      • isNoClientMove

        public boolean isNoClientMove()

      • setNoClientMove

        public MoveFileOptions setNoClientMove​(boolean noClientMove)

      • getFileType

        public java.lang.String getFileType()

      • setFileType

        public MoveFileOptions setFileType​(java.lang.String fileType)