com.perforce.p4java.option.client
Class MergeFilesOptions

java.lang.Object
  extended by com.perforce.p4java.option.Options
      extended by com.perforce.p4java.option.client.MergeFilesOptions

public class MergeFilesOptions
extends Options

Options for the IClient.mergeFiles method.

Note also that the current implementation makes no attempt to validate the sanity or otherwise of the various options and their combination.

See Also:
com.perforce.p4java.client.IClient#mergeFiles(com.perforce.p4java.core.file.IFileSpec, com.perforce.p4java.core.file.IFileSpec, java.lang.String, com.perforce.p4java.option.client.MergeFilesOptions)

Field Summary
protected  boolean bidirectionalMerge
          Cause the branch view to work bidirectionally, where the scope of the command is limited to integrations whose 'from' files match fromFile[revRange].
protected  String branch
          If non-null, use a user-defined branch view.
protected  int changelistId
          If positive, the integrated files are opened in the numbered pending changelist instead of the default changelist.
protected  boolean forceStreamMerge
          If true, force merging even though the stream does not expect a merge to occur in the direction indicated.
protected  int maxFiles
          If positive, integrate only the first maxFiles files.
static String OPTIONS_SPECS
          Options: -c[changelist], -n, -q, -m[max], -b[branch], -S[stream], -P[parentStream], -F, -r, -s
protected  String parentStream
          If non-null, specify a parent stream other than the stream's actual parent.
protected  boolean quiet
          If true, suppresses normal output messages.
protected  boolean reverseMapping
          Reverse the mappings in the branch view, with the target files and source files exchanging place.
protected  boolean showActionsOnly
          Display what integrations would be necessary but don't actually do them.
protected  String stream
          If not null, makes 'p4 integrate' use a stream's branch view.
 
Fields inherited from class com.perforce.p4java.option.Options
immutable, optionList, OPTPFX
 
Constructor Summary
MergeFilesOptions()
          Default constructor.
MergeFilesOptions(int changelistId, boolean showActionsOnly, int maxFiles, String branch, boolean reverseMapping, boolean bidirectionalInteg)
          Explicit-value constructor for use with a branch.
MergeFilesOptions(int changelistId, boolean showActionsOnly, int maxFiles, String stream, String parentStream, boolean forceStreamMerge, boolean reverseMapping)
          Explicit-value constructor for use with a stream.
MergeFilesOptions(String... options)
          Strings-based constructor; see 'p4 help [command]' for possible options.
 
Method Summary
 String getBranch()
           
 int getChangelistId()
           
 int getMaxFiles()
           
 String getParentStream()
           
 String getStream()
           
 boolean isBidirectionalInteg()
           
 boolean isForceStreamMerge()
           
 boolean isQuiet()
           
 boolean isReverseMapping()
           
 boolean isShowActionsOnly()
           
 List<String> processOptions(IServer server)
          Turn this (specific) options object into a list of strings to be sent to the Perforce server as options for a specific command.
 MergeFilesOptions setBidirectionalInteg(boolean bidirectionalInteg)
           
 MergeFilesOptions setBranch(String branch)
           
 MergeFilesOptions setChangelistId(int changelistId)
           
 MergeFilesOptions setForceStreamMerge(boolean forceStreamMerge)
           
 MergeFilesOptions setMaxFiles(int maxFiles)
           
 MergeFilesOptions setParentStream(String parentStream)
           
 MergeFilesOptions setQuiet(boolean quiet)
           
 MergeFilesOptions setReverseMapping(boolean reverseMapping)
           
 MergeFilesOptions setShowActionsOnly(boolean showActionsOnly)
           
 MergeFilesOptions setStream(String stream)
           
 
Methods inherited from class com.perforce.p4java.option.Options
applyRule, applyRule, applyRule, applyRule, getOptions, isImmutable, processFields, setImmutable, setOptions
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

OPTIONS_SPECS

public static final String OPTIONS_SPECS
Options: -c[changelist], -n, -q, -m[max], -b[branch], -S[stream], -P[parentStream], -F, -r, -s

See Also:
Constant Field Values

changelistId

protected int changelistId
If positive, the integrated files are opened in the numbered pending changelist instead of the default changelist.


bidirectionalMerge

protected boolean bidirectionalMerge
Cause 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, with the fromFile arg being specified in the main method fromFile parameter.


showActionsOnly

protected boolean showActionsOnly
Display what integrations would be necessary but don't actually do them. Corresponds to the -n flag.


quiet

protected boolean quiet
If true, suppresses normal output messages. Messages regarding errors or exceptional conditions are not suppressed. Corresponds to -q flag.


reverseMapping

protected boolean reverseMapping
Reverse the mappings in the branch view, with the target files and source files exchanging place. Corresponds to the -r flag.


maxFiles

protected int maxFiles
If positive, integrate only the first maxFiles files. Corresponds to -m 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 integrate' 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.


forceStreamMerge

protected boolean forceStreamMerge
If true, force merging even though the stream does not expect a merge to occur in the direction indicated. Normally 'p4 merge' enforces the expected flow of change dictated by the stream's spec. The 'p4 istat' command summarizes a stream's expected flow of change.

Constructor Detail

MergeFilesOptions

public MergeFilesOptions()
Default constructor.


MergeFilesOptions

public MergeFilesOptions(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.

See Also:
Options.Options(java.lang.String...)

MergeFilesOptions

public MergeFilesOptions(int changelistId,
                         boolean showActionsOnly,
                         int maxFiles,
                         String branch,
                         boolean reverseMapping,
                         boolean bidirectionalInteg)
Explicit-value constructor for use with a branch.


MergeFilesOptions

public MergeFilesOptions(int changelistId,
                         boolean showActionsOnly,
                         int maxFiles,
                         String stream,
                         String parentStream,
                         boolean forceStreamMerge,
                         boolean reverseMapping)
Explicit-value constructor for use with a stream.

Method Detail

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:
Options.processOptions(com.perforce.p4java.server.IServer)

getChangelistId

public int getChangelistId()

setChangelistId

public MergeFilesOptions setChangelistId(int changelistId)

isShowActionsOnly

public boolean isShowActionsOnly()

setShowActionsOnly

public MergeFilesOptions setShowActionsOnly(boolean showActionsOnly)

isQuiet

public boolean isQuiet()

setQuiet

public MergeFilesOptions setQuiet(boolean quiet)

isReverseMapping

public boolean isReverseMapping()

setReverseMapping

public MergeFilesOptions setReverseMapping(boolean reverseMapping)

isBidirectionalInteg

public boolean isBidirectionalInteg()

setBidirectionalInteg

public MergeFilesOptions setBidirectionalInteg(boolean bidirectionalInteg)

getMaxFiles

public int getMaxFiles()

setMaxFiles

public MergeFilesOptions setMaxFiles(int maxFiles)

getBranch

public String getBranch()

setBranch

public MergeFilesOptions setBranch(String branch)

getStream

public String getStream()

setStream

public MergeFilesOptions setStream(String stream)

getParentStream

public String getParentStream()

setParentStream

public MergeFilesOptions setParentStream(String parentStream)

isForceStreamMerge

public boolean isForceStreamMerge()

setForceStreamMerge

public MergeFilesOptions setForceStreamMerge(boolean forceStreamMerge)


Copyright © 2015 Perforce Software. All Rights Reserved.