Package 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	Description
GHTreeBuilder	add(String path, byte[] content, boolean executable)	Adds a new entry with the given binary content to the tree.
GHTreeBuilder	add(String path, String content, boolean executable)	Adds a new entry with the given text content to the tree.
GHTreeBuilder	baseTree(String baseTree)	Base tree gh tree builder.
GHTree	create()	Creates a tree based on the parameters specified thus far.
GHTreeBuilder	entry(String path, String mode, String type, String sha, String content)	Deprecated. use add(String, String, boolean) or add(String, byte[], boolean) instead.
GHTreeBuilder	shaEntry(String path, String sha, boolean executable)	Deprecated. use add(String, String, boolean) or add(String, byte[], boolean) instead.
GHTreeBuilder	textEntry(String path, String content, boolean executable)	Deprecated. use add(String, String, boolean) or add(String, byte[], boolean) instead.

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)

Base tree gh tree builder.

Parameters:

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

Returns:

the gh tree builder

entry

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

Deprecated.

use add(String, String, boolean) or add(String, byte[], boolean) instead.

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

Parameters:

path - the path

mode - the mode

type - the type

sha - the sha

content - the content

Returns:

the gh tree builder

shaEntry

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

Deprecated.

use add(String, String, boolean) or add(String, byte[], boolean) instead.

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

Parameters:

path - the path

sha - the sha

executable - the executable

Returns:

the gh tree builder

textEntry

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

Deprecated.

use add(String, String, boolean) or add(String, byte[], boolean) instead.

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

Parameters:

path - the path

content - the content

executable - the executable

Returns:

the gh tree builder

add

public GHTreeBuilder add(String path,
                         byte[] content,
                         boolean executable)

Adds a new entry with the given binary content to the tree.

Parameters:

path - the file path in the tree

content - the file content as byte array

executable - true, if the file should be executable

Returns:

this GHTreeBuilder

add

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

Adds a new entry with the given text content to the tree.

Parameters:

path - the file path in the tree

content - the file content as UTF-8 encoded string

executable - true, if the file should be executable

Returns:

this GHTreeBuilder

create

public GHTree create()
              throws IOException

Creates a tree based on the parameters specified thus far.

Returns:

the gh tree

Throws:

IOException - the io exception