Package com.perforce.p4java.option.server

Class DescribeOptions

java.lang.Object
com.perforce.p4java.option.Options
com.perforce.p4java.option.server.DescribeOptions
public class DescribeOptions extends Options
Options class for the different options that can be specified when running a describe on a changelist

  • Field Details

    • OPTIONS_SPECS

      public static final String OPTIONS_SPECS
      Options:

  • Constructor Details

    • DescribeOptions

      public DescribeOptions()
      Default constructor.

    • DescribeOptions

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

    • DescribeOptions

      public DescribeOptions(DiffType type)
      Create a changelist describe options
      Parameters:
      type - diff type

    • DescribeOptions

      public DescribeOptions(DiffType type, boolean outputShelvedDiffs)
      Create a changelist describe options
      Parameters:
      type - diff type
      outputShelvedDiffs - shelved diffs option

  • Method Details

    • getType

      public DiffType getType()
      Returns:
      the type

    • setType

      public DescribeOptions setType(DiffType type)
      Parameters:
      type - the type to set
      Returns:
      DescribeOptions class

    • isOutputShelvedDiffs

      public boolean isOutputShelvedDiffs()
      Returns:
      the showShelvedDiffs

    • setOutputShelvedDiffs

      public DescribeOptions setOutputShelvedDiffs(boolean showShelvedDiffs)
      Parameters:
      showShelvedDiffs - the showShelvedDiffs to set
      Returns:
      DescribeOptions class

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