com.buildautomation.jgit.api.AddAndListNoteOfCommit.java Source code

Java tutorial

Introduction

Here is the source code for com.buildautomation.jgit.api.AddAndListNoteOfCommit.java

Source

package com.buildautomation.jgit.api;

/*
   Copyright 2013, 2014 Dominik Stadler
    
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at
    
 http://www.apache.org/licenses/LICENSE-2.0
    
   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
 */

import org.eclipse.jgit.api.Git;
import org.eclipse.jgit.api.errors.GitAPIException;
import org.eclipse.jgit.lib.ObjectLoader;
import org.eclipse.jgit.lib.Ref;
import org.eclipse.jgit.lib.Repository;
import org.eclipse.jgit.notes.Note;
import org.eclipse.jgit.revwalk.RevCommit;
import org.eclipse.jgit.revwalk.RevWalk;

import java.io.IOException;
import java.util.List;

/**
 * Simple snippet which shows how to load Notes in a Git repository
 *
 * @author dominik.stadler at gmx.at
 */
public class AddAndListNoteOfCommit {

    public static void addAndListNoteOfCommit() throws IOException, GitAPIException {
        try (Repository repository = CookbookHelper.openJGitCookbookRepository()) {
            Ref head = repository.exactRef("refs/heads/master");
            System.out.println("Found head: " + head);

            try (RevWalk walk = new RevWalk(repository)) {
                RevCommit commit = walk.parseCommit(head.getObjectId());
                System.out.println("Found Commit: " + commit);

                try (Git git = new Git(repository)) {
                    git.notesAdd().setMessage("some note message").setObjectId(commit).call();
                    System.out.println("Added Note to commit " + commit);

                    List<Note> call = git.notesList().call();
                    System.out.println("Listing " + call.size() + " notes");
                    for (Note note : call) {
                        // check if we found the note for this commit
                        if (!note.getName().equals(head.getObjectId().getName())) {
                            System.out.println("Note " + note + " did not match commit " + head);
                            continue;
                        }
                        System.out.println("Found note: " + note + " for commit " + head);

                        // displaying the contents of the note is done via a simple blob-read
                        ObjectLoader loader = repository.open(note.getData());
                        loader.copyTo(System.out);
                    }
                }

                walk.dispose();
            }
        }
    }
}