Package com.perforce.p4java.option.server

Class GetDepotFilesOptions

java.lang.Object
com.perforce.p4java.option.Options
com.perforce.p4java.option.server.GetDepotFilesOptions
public class GetDepotFilesOptions extends Options
Simple options for the IOptionsServer.getDepotFiles method.

  • Field Details

    • OPTIONS_SPECS

      public static final String OPTIONS_SPECS
      Options: -a, -m[max]
      See Also:

    • maxResults

      protected int maxResults
      If positive, return maxResults or fewer files; note: this is an UNDOC feature and may not be supported on all servers. Corresponds to the undoc -m flag.

    • allRevs

      protected boolean allRevs
      If true, display all revisions within the specific range, rather than just the highest revision in the range. Corresponds to -a.

  • Constructor Details

    • GetDepotFilesOptions

      public GetDepotFilesOptions()
      Default constructor;

    • GetDepotFilesOptions

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

    • GetDepotFilesOptions

      public GetDepotFilesOptions(boolean allRevs)
      Explicit value constructor.
      Parameters:
      allRevs - the value for this object's allRevs field.

    • GetDepotFilesOptions

      public GetDepotFilesOptions(int maxResults, boolean allRevs)
      Explicit-value constructor.
      Parameters:
      maxResults - maxResults
      allRevs - allRevs

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

    • isAllRevs

      public boolean isAllRevs()

    • setAllRevs

      public GetDepotFilesOptions setAllRevs(boolean allRevs)

    • getMaxResults

      public int getMaxResults()

    • setMaxResults

      public GetDepotFilesOptions setMaxResults(int maxResults)