Package com.perforce.p4java.option.client

Class GetDiffFilesOptions

java.lang.Object
com.perforce.p4java.option.Options
com.perforce.p4java.option.client.GetDiffFilesOptions
public class GetDiffFilesOptions extends Options
Options subclass for the IClient.getDiffFiles method.
See Also:

  • Field Details

    • OPTIONS_SPECS

      public static final String OPTIONS_SPECS
      Options: -m[max], -t, -s[x]
      See Also:

    • maxFiles

      protected int maxFiles
      If non-zero, return only this many results. Corresponds to -m flag.

    • diffNonTextFiles

      protected boolean diffNonTextFiles
      If true, diff non-text files. Corresponds to -t flag.

    • openedDifferentMissing

      protected boolean openedDifferentMissing
      If true, report opened files that are different from the revision in the depot, or missing. Corresponds to -sa.

    • openedForIntegrate

      protected boolean openedForIntegrate
      If true, report files that are opened for integrate. Corresponds to -sb flag.

    • unopenedMissing

      protected boolean unopenedMissing
      If true, report unopened files that are missing on the client. Corresponds to -sd.

    • unopenedDifferent

      protected boolean unopenedDifferent
      If true, report unopened files that are different from the revision in the depot. Corresponds to -se flag.

    • unopenedWithStatus

      protected boolean unopenedWithStatus
      If true, report every unopened file, along with the status of 'same, 'diff', or 'missing' as compared to its revision in the depot. Corresponds to -sl.

    • openedSame

      protected boolean openedSame
      If true, report opened files that are the same as the revision in the depot. Corresponds to -sr.

  • Constructor Details

    • GetDiffFilesOptions

      public GetDiffFilesOptions()
      Default constructor.

    • GetDiffFilesOptions

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

    • GetDiffFilesOptions

      public GetDiffFilesOptions(int maxFiles, boolean diffNonTextFiles, boolean openedDifferentMissing, boolean openedForIntegrate, boolean unopenedMissing, boolean unopenedDifferent, boolean unopenedWithStatus, boolean openedSame)
      Explicit-value constructor.
      Parameters:
      maxFiles - maxFiles
      diffNonTextFiles - diffNonTextFiles
      openedDifferentMissing - openedDifferentMissing
      openedForIntegrate - openedForIntegrate
      unopenedMissing - unopenedMissing
      unopenedDifferent - unopenedDifferent
      unopenedWithStatus - unopenedWithStatus
      openedSame - openedSame

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

    • getMaxFiles

      public int getMaxFiles()

    • setMaxFiles

      public GetDiffFilesOptions setMaxFiles(int maxFiles)

    • isDiffNonTextFiles

      public boolean isDiffNonTextFiles()

    • setDiffNonTextFiles

      public GetDiffFilesOptions setDiffNonTextFiles(boolean diffNonTextFiles)

    • isOpenedDifferentMissing

      public boolean isOpenedDifferentMissing()

    • setOpenedDifferentMissing

      public GetDiffFilesOptions setOpenedDifferentMissing(boolean openedDifferentMissing)

    • isOpenedForIntegrate

      public boolean isOpenedForIntegrate()

    • setOpenedForIntegrate

      public GetDiffFilesOptions setOpenedForIntegrate(boolean openedForIntegrate)

    • isUnopenedMissing

      public boolean isUnopenedMissing()

    • setUnopenedMissing

      public GetDiffFilesOptions setUnopenedMissing(boolean unopenedMissing)

    • isUnopenedDifferent

      public boolean isUnopenedDifferent()

    • setUnopenedDifferent

      public GetDiffFilesOptions setUnopenedDifferent(boolean unopenedDifferent)

    • isUnopenedWithStatus

      public boolean isUnopenedWithStatus()

    • setUnopenedWithStatus

      public GetDiffFilesOptions setUnopenedWithStatus(boolean unopenedWithStatus)

    • isOpenedSame

      public boolean isOpenedSame()

    • setOpenedSame

      public GetDiffFilesOptions setOpenedSame(boolean openedSame)