Package com.perforce.p4java.option.server

Class GetInterchangesOptions

java.lang.Object
com.perforce.p4java.option.Options
com.perforce.p4java.option.server.GetInterchangesOptions
public class GetInterchangesOptions extends Options
Options class for the IOptionsServer getInterchanges methods. Serves for both getInterchanges method signatures, but not all options are honored by both methods -- check the corresponding main Perforce documentation.

  • Field Details

    • OPTIONS_SPECS

      public static final String OPTIONS_SPECS
      Options: -f, -l, -C[changelist], -b[branch], -S[stream], -P[parentStream], -r, -s

      NOTE: not all options will be recognized by the specific version of the getInterchanges method being called.

      See Also:

    • showFiles

      protected boolean showFiles
      If true, show the individual files that would require integration. Corresponds to -f flag.

    • longDesc

      protected boolean longDesc
      If true, produce long output with the full text of the changelist descriptions. Corresponds to -l flag.

    • maxChangelistId

      protected int maxChangelistId
      If greater than zero, only consider integration history from changelists at or below the given number. Corresponds to the undoc -C flag.

    • reverseMapping

      protected boolean reverseMapping
      If true, reverse the mappings in the branch view, with the target files and source files exchanging place. Correspsonds to the -r flag.

    • biDirectional

      protected boolean biDirectional
      If true, causes the branch view to work bidirectionally, where the scope of the command is limited to integrations whose 'from' files match fromFile[revRange]. Corresponds to the -s flag.

    • branch

      protected String branch
      If non-null, use a user-defined branch view. The source is the left side of the branch view and the target is the right side. With -r, the direction is reversed. Corresponds to -b flag.

    • stream

      protected String stream
      If not null, makes 'p4 interchanges' use a stream's branch view. The source is the stream itself, and the target is the stream's parent. With -r, the direction is reversed. -P can be used to specify a parent stream other than the stream's actual parent. Note that to submit integrated stream files, the current client must be dedicated to the target stream. Corresponds to -S flag.

    • parentStream

      protected String parentStream
      If non-null, specify a parent stream other than the stream's actual parent. Corresponds to -P flag.

  • Constructor Details

    • GetInterchangesOptions

      public GetInterchangesOptions()
      Default constructor.

    • GetInterchangesOptions

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

    • GetInterchangesOptions

      public GetInterchangesOptions(boolean showFiles, boolean longDesc, int maxChangelistId, boolean reverseMapping, boolean biDirectional)
      Explicit-value constructor.
      Parameters:
      showFiles - showFiles
      longDesc - longDesc
      maxChangelistId - maxChangelistId
      reverseMapping - reverseMapping
      biDirectional - biDirectional

    • GetInterchangesOptions

      public GetInterchangesOptions(boolean showFiles, boolean longDesc, int maxChangelistId, String branch, boolean reverseMapping, boolean biDirectional)
      Explicit-value constructor for use with a branch.
      Parameters:
      showFiles - showFiles
      longDesc - longDesc
      maxChangelistId - maxChangelistId
      branch - branch
      reverseMapping - reverseMapping
      biDirectional - biDirectional

    • GetInterchangesOptions

      public GetInterchangesOptions(boolean showFiles, boolean longDesc, int maxChangelistId, String stream, String parentStream, boolean reverseMapping, boolean biDirectional)
      Explicit-value constructor for use with a stream.
      Parameters:
      showFiles - showFiles
      longDesc - longDesc
      maxChangelistId - maxChangelistId
      stream - stream
      parentStream - parentStream
      reverseMapping - reverseMapping
      biDirectional - biDirectional

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

    • isShowFiles

      public boolean isShowFiles()

    • setShowFiles

      public GetInterchangesOptions setShowFiles(boolean showFiles)

    • isLongDesc

      public boolean isLongDesc()

    • setLongDesc

      public GetInterchangesOptions setLongDesc(boolean longDesc)

    • getMaxChangelistId

      public int getMaxChangelistId()

    • setMaxChangelistId

      public GetInterchangesOptions setMaxChangelistId(int maxChangelistId)

    • isReverseMapping

      public boolean isReverseMapping()

    • setReverseMapping

      public GetInterchangesOptions setReverseMapping(boolean reverseMapping)

    • isBiDirectional

      public boolean isBiDirectional()

    • setBiDirectional

      public GetInterchangesOptions setBiDirectional(boolean biDirectional)

    • getBranch

      public String getBranch()

    • setBranch

      public GetInterchangesOptions setBranch(String branch)

    • getStream

      public String getStream()

    • setStream

      public GetInterchangesOptions setStream(String stream)

    • getParentStream

      public String getParentStream()

    • setParentStream

      public GetInterchangesOptions setParentStream(String parentStream)