forked from hub4j/github-api
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathGHLicense.java
More file actions
245 lines (218 loc) · 6.32 KB
/
Copy pathGHLicense.java
File metadata and controls
245 lines (218 loc) · 6.32 KB
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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
/*
* The MIT License
*
* Copyright (c) 2016, Duncan Dickinson
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package org.kohsuke.github;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import java.io.IOException;
import java.net.URL;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
// TODO: Auto-generated Javadoc
/**
* The GitHub Preview API's license information.
*
* @author Duncan Dickinson
* @see GitHub#getLicense(String) GitHub#getLicense(String)
* @see GHRepository#getLicense() GHRepository#getLicense()
* @see <a href="https://developer.github.com/v3/licenses/">https://developer.github.com/v3/licenses/</a>
*/
@SuppressWarnings({ "UnusedDeclaration" })
@SuppressFBWarnings(value = { "UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD", "NP_UNWRITTEN_FIELD" },
justification = "JSON API")
public class GHLicense extends GHObject {
/** The name. */
// these fields are always present, even in the short form
protected String key, name;
/** The featured. */
// the rest is only after populated
protected Boolean featured;
/** The body. */
protected String html_url, description, category, implementation, body;
/** The required. */
protected List<String> required = new ArrayList<String>();
/** The permitted. */
protected List<String> permitted = new ArrayList<String>();
/** The forbidden. */
protected List<String> forbidden = new ArrayList<String>();
/**
* Gets key.
*
* @return a mnemonic for the license
*/
public String getKey() {
return key;
}
/**
* Gets name.
*
* @return the license name
*/
public String getName() {
return name;
}
/**
* Featured licenses are bold in the new repository drop-down.
*
* @return True if the license is featured, false otherwise
* @throws IOException
* the io exception
*/
public Boolean isFeatured() throws IOException {
populate();
return featured;
}
/**
* Gets the html url.
*
* @return the html url
* @throws IOException
* Signals that an I/O exception has occurred.
*/
public URL getHtmlUrl() throws IOException {
populate();
return GitHubClient.parseURL(html_url);
}
/**
* Gets description.
*
* @return the description
* @throws IOException
* the io exception
*/
public String getDescription() throws IOException {
populate();
return description;
}
/**
* Gets category.
*
* @return the category
* @throws IOException
* the io exception
*/
public String getCategory() throws IOException {
populate();
return category;
}
/**
* Gets implementation.
*
* @return the implementation
* @throws IOException
* the io exception
*/
public String getImplementation() throws IOException {
populate();
return implementation;
}
/**
* Gets required.
*
* @return the required
* @throws IOException
* the io exception
*/
public List<String> getRequired() throws IOException {
populate();
return Collections.unmodifiableList(required);
}
/**
* Gets permitted.
*
* @return the permitted
* @throws IOException
* the io exception
*/
public List<String> getPermitted() throws IOException {
populate();
return Collections.unmodifiableList(permitted);
}
/**
* Gets forbidden.
*
* @return the forbidden
* @throws IOException
* the io exception
*/
public List<String> getForbidden() throws IOException {
populate();
return Collections.unmodifiableList(forbidden);
}
/**
* Gets body.
*
* @return the body
* @throws IOException
* the io exception
*/
public String getBody() throws IOException {
populate();
return body;
}
/**
* Fully populate the data by retrieving missing data.
* <p>
* Depending on the original API call where this object is created, it may not contain everything.
*
* @throws IOException
* the io exception
*/
protected synchronized void populate() throws IOException {
if (description != null)
return; // already populated
if (isOffline()) {
return; // cannot populate, will have to live with what we have
}
URL url = getUrl();
if (url != null) {
root().createRequest().setRawUrlPath(url.toString()).fetchInto(this);
}
}
/**
* Equals.
*
* @param o
* the o
* @return true, if successful
*/
@Override
public boolean equals(Object o) {
if (this == o)
return true;
if (!(o instanceof GHLicense))
return false;
GHLicense that = (GHLicense) o;
return Objects.equals(getUrl(), that.getUrl());
}
/**
* Hash code.
*
* @return the int
*/
@Override
public int hashCode() {
return Objects.hashCode(getUrl());
}
}