Module org.eclipse.jgit
Package org.eclipse.jgit.merge

Class MergeFormatter

java.lang.Object
org.eclipse.jgit.merge.MergeFormatter
public class MergeFormatter extends Object
A class to convert merge results into a Git conformant textual presentation

  • Constructor Details

    • MergeFormatter

      public MergeFormatter()

  • Method Details

    • formatMerge

      public void formatMerge(OutputStream out, MergeResult<RawText> res, List<String> seqName, Charset charset) throws IOException
      Formats the results of a merge of RawText objects in a Git conformant way. This method also assumes that the RawText objects being merged are line oriented files which use LF as delimiter. This method will also use LF to separate chunks and conflict metadata, therefore it fits only to texts that are LF-separated lines.
      Parameters:
      out - the output stream where to write the textual presentation
      res - the merge result which should be presented
      seqName - When a conflict is reported each conflicting range will get a name. This name is following the "<<<<<<< " or ">>>>>>> " conflict markers. The names for the sequences are given in this list
      charset - the character set used when writing conflict metadata
      Throws:
      IOException - if an IO error occurred
      Since:
      5.2

    • formatMergeDiff3

      public void formatMergeDiff3(OutputStream out, MergeResult<RawText> res, List<String> seqName, Charset charset) throws IOException
      Formats the results of a merge of RawText objects in a Git conformant way using diff3 style. This method also assumes that the RawText objects being merged are line oriented files which use LF as delimiter. This method will also use LF to separate chunks and conflict metadata, therefore it fits only to texts that are LF-separated lines.
      Parameters:
      out - the output stream where to write the textual presentation
      res - the merge result which should be presented
      seqName - When a conflict is reported each conflicting range will get a name. This name is following the "<<<<<<< ", "|||||||" or ">>>>>>> " conflict markers. The names for the sequences are given in this list
      charset - the character set used when writing conflict metadata
      Throws:
      IOException - if an IO error occurred
      Since:
      6.7

    • formatMerge

      public void formatMerge(OutputStream out, MergeResult res, String baseName, String oursName, String theirsName, Charset charset) throws IOException
      Formats the results of a merge of exactly two RawText objects in a Git conformant way. This convenience method accepts the names for the three sequences (base and the two merged sequences) as explicit parameters and doesn't require the caller to specify a List
      Parameters:
      out - the OutputStream where to write the textual presentation
      res - the merge result which should be presented
      baseName - the name ranges from the base should get
      oursName - the name ranges from ours should get
      theirsName - the name ranges from theirs should get
      charset - the character set used when writing conflict metadata
      Throws:
      IOException - if an IO error occurred
      Since:
      5.2

    • formatMergeDiff3

      public void formatMergeDiff3(OutputStream out, MergeResult res, String baseName, String oursName, String theirsName, Charset charset) throws IOException
      Formats the results of a merge of three RawText objects in a Git conformant way, using diff-3 style. This convenience method accepts the names for the three sequences (base and the two merged sequences) as explicit parameters and doesn't require the caller to specify a List
      Parameters:
      out - the OutputStream where to write the textual presentation
      res - the merge result which should be presented
      baseName - the name ranges from the base should get
      oursName - the name ranges from ours should get
      theirsName - the name ranges from theirs should get
      charset - the character set used when writing conflict metadata
      Throws:
      IOException - if an IO error occurred
      Since:
      6.7