Package com.perforce.p4java.option.server

Class FixJobsOptions

  • public class FixJobsOptions
extends Options
    Options class for the IOptionsServer fixJobs method.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected boolean delete
      If true, delete the specified fixes.
      static java.lang.String OPTIONS_SPECS
      Options: -s[status], -d
      protected java.lang.String status
      If not null, use this as the new status rather than "closed".

    • Constructor Summary

      Constructors 
      Constructor Description
      FixJobsOptions()
      Default constructor.
      FixJobsOptions​(java.lang.String... options)
      Strings-based constructor; see 'p4 help [command]' for possible options.
      FixJobsOptions​(java.lang.String status, boolean delete)
      Explicit-value constructor.

    • Field Detail

      • OPTIONS_SPECS

        public static final java.lang.String OPTIONS_SPECS
        Options: -s[status], -d
        See Also:
        Constant Field Values

      • status

        protected java.lang.String status
        If not null, use this as the new status rather than "closed". Corresponds to the -s flag.

      • delete

        protected boolean delete
        If true, delete the specified fixes. Corresponds to the -d flag.

    • Constructor Detail

      • FixJobsOptions

        public FixJobsOptions()
        Default constructor.

      • FixJobsOptions

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

      • FixJobsOptions

        public FixJobsOptions​(java.lang.String status,
                      boolean delete)
        Explicit-value constructor.
        Parameters:
        status - status
        delete - delete option

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

      • getStatus

        public java.lang.String getStatus()

      • setStatus

        public FixJobsOptions setStatus​(java.lang.String status)

      • isDelete

        public boolean isDelete()