org.kohsuke.github

Class GHBranch

java.lang.Object

org.kohsuke.github.GHBranch

public class GHBranch
extends Object

A branch in a repository.

Author:

Yusuke Kokubo

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GHBranch.Commit

Constructor Summary

Constructors

Constructor and Description
GHBranch()

Method Summary

Modifier and Type	Method and Description
void	disableProtection() Disables branch protection and allows anyone with push access to push changes.
GHBranchProtectionBuilder	enableProtection() Deprecated.
void	enableProtection(EnforcementLevel level, Collection<String> contexts) Deprecated.
String	getName()
GHRepository	getOwner() Repository that this branch is in.
GHBranchProtection	getProtection()
URL	getProtectionUrl() Deprecated.
GitHub	getRoot()
String	getSHA1() The commit that this branch currently points to.
boolean	isProtected() Deprecated.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GHBranch

public GHBranch()

Method Detail

getRoot

public GitHub getRoot()

getOwner

public GHRepository getOwner()

Repository that this branch is in.

getName

public String getName()

isProtected

@Preview
 @Deprecated
public boolean isProtected()

Deprecated.

Returns true if the push to this branch is restricted via branch protection.

getProtectionUrl

@Preview
 @Deprecated
public URL getProtectionUrl()

Deprecated.

Returns API URL that deals with the protection of this branch.

getProtection

public GHBranchProtection getProtection()
                                 throws IOException

Throws:

IOException

getSHA1

public String getSHA1()

The commit that this branch currently points to.

disableProtection

public void disableProtection()
                       throws IOException

Disables branch protection and allows anyone with push access to push changes.

Throws:

IOException

enableProtection

@Preview
 @Deprecated
public GHBranchProtectionBuilder enableProtection()

Deprecated.

Enables branch protection to control what commit statuses are required to push.

See Also:

GHCommitStatus.getContext()

enableProtection

@Deprecated
public void enableProtection(EnforcementLevel level,
                                         Collection<String> contexts)
                                  throws IOException

Deprecated.

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object