com.rultor.scm.git

Class Git

java.lang.Object

com.rultor.scm.git.Git

All Implemented Interfaces:

SCM

@Immutable
@Loggable(value=1)
public final class Git
extends Object
implements SCM

Git.

It is assumed that BASH is installed inside that shell.

Since:

1.0

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

Suppressed Checkstyle violations:

ClassDataAbstractionCoupling (500 lines)

Constructor Summary

Constructors

Constructor and Description
Git(Shell shl, URI addr, String folder) Public ctor.
Git(Shell shl, URI addr, String folder, PrivateKey priv) Public ctor.

Method Summary

Methods

Modifier and Type	Method and Description
Collection<String>	branches() Get all available branches/tags.
Branch	checkout(String name) Checkout branch.
Iterable<Commit>	log(String branch) Get log of the branch.
URI	uri() URI of it.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Git

public Git(@NotNull(message="shell can\'t be NULL")
   Shell shl,
   @NotNull(message="URI can\'t be NULL")
   URI addr,
   @NotNull(message="folder can\'t be NULL")
   String folder)

Public ctor.

Parameters:

shl - Shell to use for checkout

addr - URL of git repository

folder - Directory to use for clone

Git

public Git(Shell shl,
   URI addr,
   String folder,
   PrivateKey priv)

Public ctor.

Parameters:

shl - Shell to use for checkout

addr - URI of git repository

folder - Directory to use for clone

priv - Private key to use locally

Suppressed Checkstyle violations:

ParameterNumber (5 lines)

Method Detail

checkout

@Step(value="Git branch `${args[0]}` checked out")
@RetryOnFailure(verbose=false)
@Loggable(value=1,
          limit=5)
public Branch checkout(String name)
                throws IOException

Description copied from interface: SCM

Checkout branch.

Specified by:

checkout in interface SCM

Parameters:

name - Branch name to checkout (SCM dependent)

Returns:

Branch

Throws:

IOException - If fails

branches

@Step(value="found ${result.size()} refs in Git")
@RetryOnFailure(verbose=false)
public Collection<String> branches()
                            throws IOException

Description copied from interface: SCM

Get all available branches/tags.

Specified by:

branches in interface SCM

Returns:

Branches/tags

Throws:

IOException - If fails

uri

public URI uri()

Description copied from interface: SCM

URI of it.

Specified by:

uri in interface SCM

Returns:

URI of the SCM

log

@RetryOnFailure(verbose=false)
@Loggable(value=1,
          limit=5,
          ignore=java.io.IOException.class)
public Iterable<Commit> log(String branch)
                     throws IOException

Get log of the branch.

Parameters:

branch - Branch name

Returns:

Iterable commits

Throws:

IOException - If fails