org.kohsuke.github

Class GHTreeBuilder

java.lang.Object

org.kohsuke.github.GHTreeBuilder

public class GHTreeBuilder
extends Object

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

Method Summary

Modifier and Type	Method and Description
GHTreeBuilder	baseTree(String baseTree)
GHTree	create() Creates a tree based on the parameters specified thus far.
GHTreeBuilder	entry(String path, String mode, String type, String sha, String content) Adds a new entry to the tree.
GHTreeBuilder	shaEntry(String path, String sha, boolean executable) Specialized version of entry(String, String, String, String, String) for adding an existing blob referred by its SHA.
GHTreeBuilder	textEntry(String path, String content, boolean executable) Specialized version of entry(String, String, String, String, String) for adding a text file with the specified content.

Methods inherited from class java.lang.Object

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

Method Detail

baseTree

public GHTreeBuilder baseTree(String baseTree)

Parameters:

baseTree - the SHA of tree you want to update with new data

entry

public GHTreeBuilder entry(String path,
                           String mode,
                           String type,
                           String sha,
                           String content)

Adds a new entry to the tree. Exactly one of the parameters sha and content must be non-null.

shaEntry

public GHTreeBuilder shaEntry(String path,
                              String sha,
                              boolean executable)

Specialized version of entry(String, String, String, String, String) for adding an existing blob referred by its SHA.

textEntry

public GHTreeBuilder textEntry(String path,
                               String content,
                               boolean executable)

Specialized version of entry(String, String, String, String, String) for adding a text file with the specified content.

create

public GHTree create()
              throws IOException

Creates a tree based on the parameters specified thus far.

Throws:

IOException