org.kohsuke.github

Class GHCommitBuilder

java.lang.Object

org.kohsuke.github.GHCommitBuilder

public class GHCommitBuilder
extends Object

Builder pattern for creating a new commit. Based on https://developer.github.com/v3/git/commits/#create-a-commit

Method Summary

Modifier and Type	Method and Description
GHCommitBuilder	author(String name, String email, Date date) Configures the author of this commit.
GHCommitBuilder	committer(String name, String email, Date date) Configures the committer of this commit.
GHCommit	create() Creates a blob based on the parameters specified thus far.
GHCommitBuilder	message(String message)
GHCommitBuilder	parent(String parent)
GHCommitBuilder	tree(String tree)

Methods inherited from class java.lang.Object

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

Method Detail

message

public GHCommitBuilder message(String message)

Parameters:

message - the commit message

tree

public GHCommitBuilder tree(String tree)

Parameters:

tree - the SHA of the tree object this commit points to

parent

public GHCommitBuilder parent(String parent)

Parameters:

parent - the SHA of a parent commit.

author

public GHCommitBuilder author(String name,
                              String email,
                              Date date)

Configures the author of this commit.

committer

public GHCommitBuilder committer(String name,
                                 String email,
                                 Date date)

Configures the committer of this commit.

create

public GHCommit create()
                throws IOException

Creates a blob based on the parameters specified thus far.

Throws:

IOException