Package com.perforce.p4java.option.client

Class RevertFilesOptions

    • Field Detail

      • OPTIONS_SPECS

        public static final java.lang.String OPTIONS_SPECS
        Options: -n, -cN, -a, -k, -w, -So, -Si
        See Also:
        Constant Field Values

      • noUpdate

        protected boolean noUpdate
        If true, don't actually do the revert, just return the files that would have been opened for reversion. Corresponds to -n.

      • changelistId

        protected int changelistId
        If non-negative, limits reversion to files opened under the given, pending changelist. Corresponds to -c.

      • revertOnlyUnchanged

        protected boolean revertOnlyUnchanged
        If true, revert only files which are opened for edit or integrate and are unchanged or missing. Corresponds to -a.

      • noClientRefresh

        protected boolean noClientRefresh
        If true bypass the client file refresh. Corresponds to -k.

      • wipeAddFiles

        protected boolean wipeAddFiles
        If true causes files that are open for add to be deleted from the workspace when they are reverted. Corresponds to -w.

      • revertStreamSpec

        protected boolean revertStreamSpec
        If true flag can be used with '-c change' to revert the client's open stream spec. Only Stream spec is reverted, no files are reverted, for reverting files and Stream spec use revertFileList.

      • revertFileList

        protected boolean revertFileList
        If true the flag can be used with a file list to include an open stream spec when reverting files. Reverts both files and open stream spec.

    • Constructor Detail

      • RevertFilesOptions

        public RevertFilesOptions()
        Default constructor.

      • RevertFilesOptions

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

      • RevertFilesOptions

        public RevertFilesOptions​(boolean noUpdate,
                          int changeListId,
                          boolean revertOnlyUnchanged,
                          boolean noClientRefresh)
        Explicit-value constructor.
        Parameters:
        noUpdate - noUpdate
        changeListId - changeListId
        revertOnlyUnchanged - revertOnlyUnchanged
        noClientRefresh - noClientRefresh

    • 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)

      • isNoUpdate

        public boolean isNoUpdate()

      • getChangelistId

        public int getChangelistId()

      • isRevertOnlyUnchanged

        public boolean isRevertOnlyUnchanged()

      • setRevertOnlyUnchanged

        public RevertFilesOptions setRevertOnlyUnchanged​(boolean revertOnlyUnchanged)

      • isNoClientRefresh

        public boolean isNoClientRefresh()

      • setNoClientRefresh

        public RevertFilesOptions setNoClientRefresh​(boolean noClientRefresh)

      • isWipeAddFiles

        public boolean isWipeAddFiles()

      • isRevertStreamSpec

        public boolean isRevertStreamSpec()

      • setRevertStreamSpec

        public RevertFilesOptions setRevertStreamSpec​(boolean revertStreamSpec)

      • isRevertFileList

        public boolean isRevertFileList()

      • setRevertFileList

        public RevertFilesOptions setRevertFileList​(boolean revertFileList)