Package com.perforce.p4java.option.server

Class GetServerProcessesOptions

java.lang.Object
com.perforce.p4java.option.Options
com.perforce.p4java.option.server.GetServerProcessesOptions
public class GetServerProcessesOptions extends Options
Options class for Perforce IOptionsServer.getServerProcesses method.

See 'p4 help monitor' for help specifying the monitor 'show' flags.

  • Field Details

    • OPTIONS_SPECS

      public static final String OPTIONS_SPECS
      Options: -a, -e, -l, -s R/T/P/I
      See Also:

    • includeCmdArgs

      protected boolean includeCmdArgs
      If true, includes the command args. Corresponds to the -a flag.

    • includeCmdEnv

      protected boolean includeCmdEnv
      If true, includes the command environment. For each process, client application (if known), host address and client name are displayed. Corresponds to the -e flag.

    • longOutput

      protected boolean longOutput
      If true, displays long output, including the full username and argument list. Corresponds to the -l flag.

    • processState

      protected String processState
      If non-null, restricts the display to processes in the indicated state: [R]unning, [T]erminated, [P]aused, or [I]dle. Corresponds to -s R/T/P/I flag.

  • Constructor Details

    • GetServerProcessesOptions

      public GetServerProcessesOptions()
      Default constructor.

    • GetServerProcessesOptions

      public GetServerProcessesOptions(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:

    • GetServerProcessesOptions

      public GetServerProcessesOptions(boolean includeCmdArgs, boolean includeCmdEnv, boolean longOutput, String processState)
      Explicit value constructor.
      Parameters:
      includeCmdArgs - includeCmdArgs
      includeCmdEnv - includeCmdEnv
      longOutput - longOutput
      processState - processState

  • Method Details

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

    • isIncludeCmdArgs

      public boolean isIncludeCmdArgs()

    • setIncludeCmdArgs

      public GetServerProcessesOptions setIncludeCmdArgs(boolean includeCmdArgs)

    • isIncludeCmdEnv

      public boolean isIncludeCmdEnv()

    • setIncludeCmdEnv

      public GetServerProcessesOptions setIncludeCmdEnv(boolean includeCmdEnv)

    • isLongOutput

      public boolean isLongOutput()

    • setLongOutput

      public GetServerProcessesOptions setLongOutput(boolean longOutput)

    • getProcessState

      public String getProcessState()

    • setProcessState

      public GetServerProcessesOptions setProcessState(String processState)