com.itemis.maven.plugins.unleash.scm.merge.MergeClient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of unleash-scm-provider-api Show documentation

The API used by the Unleash Maven Plugin to talk to different SCM providers.

There is a newer version: 3.1.0

Show newest version

package com.itemis.maven.plugins.unleash.scm.merge;

import java.io.InputStream;
import java.io.OutputStream;

import com.itemis.maven.plugins.unleash.scm.ScmException;
import com.itemis.maven.plugins.unleash.scm.ScmProvider;

/**
 * The callback interface used by the {@link ScmProvider ScmProviders} for merge conflict resolution.
 *
 * @author Stanley Hillner
 * @since 0.1.0
 */
public interface MergeClient {

  /**
   * Merges conflicting local and remote changes and writes back the merge result into the output stream.
   *
   * @param local the local copy of the conflicting file as a stream. This stream will be closed
   *          automatically afterwards.
   * @param remote the remote copy of the conflicting file as a stream. This stream will be closed
   *          automatically afterwards.
   * @param base the base copy of the conflicting file (as a stream) which is the ancestor of both, the local and remote
   *          file. This stream will be closed automatically afterwards.
   * @param result an output stream to which the merge result can be written. This output stream will be closed
   *          automatically afterwards.
   * @throws ScmException if anything goes wrong during the merge operation.
   */
  void merge(InputStream local, InputStream remote, InputStream base, OutputStream result) throws ScmException;
}