org.kohsuke.github

Class GHRef

java.lang.Object

org.kohsuke.github.GHRef

public class GHRef
extends java.lang.Object

Provides information on a Git ref from GitHub.

Author:

Michael Clarke

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GHRef.GHObject

Constructor Summary

Constructors

Constructor and Description
GHRef()

Method Summary

Modifier and Type	Method and Description
void	delete() Deletes this ref from the repository using the GitHub API.
GHRef.GHObject	getObject() The object that this ref points to.
java.lang.String	getRef() Name of the ref, such as "refs/tags/abc"
java.net.URL	getUrl() The API URL of this tag, such as https://api.github.com/repos/jenkinsci/jenkins/git/refs/tags/1.312
void	updateTo(java.lang.String sha) Updates this ref to the specified commit.
void	updateTo(java.lang.String sha, java.lang.Boolean force) Updates this ref to the specified commit.

Methods inherited from class java.lang.Object

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

Constructor Detail

GHRef

public GHRef()

Method Detail

getRef

public java.lang.String getRef()

Name of the ref, such as "refs/tags/abc"

getUrl

public java.net.URL getUrl()

The API URL of this tag, such as https://api.github.com/repos/jenkinsci/jenkins/git/refs/tags/1.312

getObject

public GHRef.GHObject getObject()

The object that this ref points to.

updateTo

public void updateTo(java.lang.String sha)
              throws java.io.IOException

Updates this ref to the specified commit.

Parameters:

sha - The SHA1 value to set this reference to

Throws:

java.io.IOException

updateTo

public void updateTo(java.lang.String sha,
                     java.lang.Boolean force)
              throws java.io.IOException

Updates this ref to the specified commit.

Parameters:

sha - The SHA1 value to set this reference to

force - Whether or not to force this ref update.

Throws:

java.io.IOException

delete

public void delete()
            throws java.io.IOException

Deletes this ref from the repository using the GitHub API.

Throws:

java.io.IOException