FilesExpand file tree

 master

/

GHRef.java

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

107 lines (92 loc) · 2.57 KB

 master

/

GHRef.java

Copy path

Top

File metadata and controls

• Code
• Blame

107 lines (92 loc) · 2.57 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

package org.kohsuke.github;

import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;

import java.io.IOException;

import java.net.URL;

/**

* Provides information on a Git ref from GitHub.

*

* @author Michael Clarke

*/

public class GHRef {

/*package almost final*/ GitHub root;

private String ref, url;

private GHObject object;

/**

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

*/

public String getRef() {

return ref;

}

/**

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

*/

public URL getUrl() {

return GitHub.parseURL(url);

}

/**

* The object that this ref points to.

*/

public GHObject getObject() {

return object;

}

/**

* Updates this ref to the specified commit.

*

* @param sha

* The SHA1 value to set this reference to

*/

public void updateTo(String sha) throws IOException {

updateTo(sha, false);

}

/**

* Updates this ref to the specified commit.

*

* @param sha

* The SHA1 value to set this reference to

* @param force

* Whether or not to force this ref update.

*/

public void updateTo(String sha, Boolean force) throws IOException {

new Requester(root)

.with("sha", sha).with("force", force).method("PATCH").to(url, GHRef.class).wrap(root);

}

/**

* Deletes this ref from the repository using the GitHub API.

*/

public void delete() throws IOException {

new Requester(root).method("DELETE").to(url);

}

/*package*/ GHRef wrap(GitHub root) {

this.root = root;

return this;

}

/*package*/ static GHRef[] wrap(GHRef[] in, GitHub root) {

for (GHRef r : in) {

r.wrap(root);

}

return in;

}

@SuppressFBWarnings(value = {"UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD",

"NP_UNWRITTEN_FIELD"}, justification = "JSON API")

public static class GHObject {

private String type, sha, url;

/**

* Type of the object, such as "commit"

*/

public String getType() {

return type;

}

/**

* SHA1 of this object.

*/

public String getSha() {

return sha;

}

/**

* API URL to this Git data, such as https://api.github.com/repos/jenkinsci/jenkins/git/commits/b72322675eb0114363a9a86e9ad5a170d1d07ac0

*/

public URL getUrl() {

return GitHub.parseURL(url);

}

}

}