com.g2forge.gearbox.git.GitConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gb-git Show documentation

A thin wrapper of helpers methods around JGit.

There is a newer version: 0.0.9

package com.g2forge.gearbox.git;

import java.io.IOException;

import org.eclipse.jgit.api.Git;
import org.eclipse.jgit.lib.Constants;
import org.eclipse.jgit.lib.StoredConfig;

import com.g2forge.alexandria.java.io.RuntimeIOException;

import lombok.AccessLevel;
import lombok.Getter;
import lombok.RequiredArgsConstructor;

/**
 * Accessor for git repository configuration, including {@link GitRemote remotes}.
 */
@RequiredArgsConstructor
@Getter(AccessLevel.PROTECTED)
public class GitConfig implements IGitConfigAccessor {
	protected final StoredConfig config;

	public GitConfig(Git git) {
		this(git.getRepository().getConfig());
	}

	public GitRemote getOrigin() {
		return getRemote(Constants.DEFAULT_REMOTE_NAME);
	}

	/**
	 * Get access to a remote with the specified name, which may or may not already be configured.
	 * 
	 * @param name The name of the remote.
	 * @return An accessor which can be used to add, delete, modify or get information about the remote.
	 */
	public GitRemote getRemote(String name) {
		return new GitRemote(this, name);
	}

	@Override
	public void save() {
		try {
			getConfig().save();
		} catch (IOException exception) {
			throw new RuntimeIOException("Failed to save git repository configuration!", exception);
		}
	}
}