Module org.kohsuke.github.api

Package org.kohsuke.github

Class GHTree

java.lang.Object

org.kohsuke.github.GHTree

public class GHTree
extends Object

Provides information for Git Trees https://developer.github.com/v3/git/trees/

Author:

Daniel Teixeira - https://github.com/ddtxra

See Also:

• GHCommit#getTree()
• GHRepository#getTree(String)
• GHTreeEntry#asTree()

Constructor Summary

Constructors

Constructor	Description
GHTree()	Create default GHTree instance

Method Summary

Modifier and Type	Method	Description
GHTreeEntry	getEntry(String path)	Finds a tree entry by its name.
String	getSha()	The SHA for this trees.
List<GHTreeEntry>	getTree()	Return an array of entries of the trees.
URL	getUrl()	The API URL of this tag, such as "url": "https://api.github.com/repos/octocat/Hello-World/trees/fc6274d15fa3ae2ab983129fb037999f264ba9a7",
boolean	isTruncated()	Returns true if the number of items in the tree array exceeded the GitHub maximum limit.

Methods inherited from class java.lang.Object

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

Constructor Details

GHTree

public GHTree()

Create default GHTree instance

Method Details

getSha

public String getSha()

The SHA for this trees.

Returns:

the sha

getTree

public List<GHTreeEntry> getTree()

Return an array of entries of the trees.

Returns:

the tree

getEntry

public GHTreeEntry getEntry(String path)

Finds a tree entry by its name.

IOW, find a directory entry by a file name.

Parameters:

path - the path

Returns:

the entry

isTruncated

public boolean isTruncated()

Returns true if the number of items in the tree array exceeded the GitHub maximum limit.

Returns:

true if the number of items in the tree array exceeded the GitHub maximum limit otherwise false.

getUrl

public URL getUrl()

The API URL of this tag, such as "url": "https://api.github.com/repos/octocat/Hello-World/trees/fc6274d15fa3ae2ab983129fb037999f264ba9a7",

Returns:

the url