Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in / Register
Toggle navigation
Menu
Open sidebar
佳 邓
Gitlab4j Api
Commits
44b0012e
Commit
44b0012e
authored
Oct 01, 2019
by
Greg Messner
Browse files
Renamed LicensesApi to LicenseTemplatesApi (43).
parent
9562a702
Changes
2
Hide whitespace changes
Inline
Side-by-side
src/main/java/org/gitlab4j/api/LicenseTemplatesApi.java
0 → 100644
View file @
44b0012e
package
org.gitlab4j.api
;
import
java.util.List
;
import
java.util.Optional
;
import
java.util.stream.Stream
;
import
javax.ws.rs.core.Response
;
import
org.gitlab4j.api.models.LicenseTemplate
;
/**
* This class provides an entry point to all the GitLab API licenses calls.
@see <a href="https://docs.gitlab.com/ce/api/templates/licenses.html">Licenses API</a>
*/
public
class
LicenseTemplatesApi
extends
AbstractApi
{
public
LicenseTemplatesApi
(
GitLabApi
gitLabApi
)
{
super
(
gitLabApi
);
}
/**
* Get a List of all license templates.
*
* <pre><code>GitLab Endpoint: GET /templates/licenses</code></pre>
*
* @return a list of LicenseTemplate instances
* @throws GitLabApiException if any exception occurs
*/
public
List
<
LicenseTemplate
>
getLicenseTemplates
()
throws
GitLabApiException
{
return
(
getLicenseTemplates
(
false
,
getDefaultPerPage
()).
all
());
}
/**
* Get a Stream of all license templates.
*
* <pre><code>GitLab Endpoint: GET /templates/licenses</code></pre>
*
* @return a list of LicenseTemplate instances
* @throws GitLabApiException if any exception occurs
*/
public
Stream
<
LicenseTemplate
>
getLicenseTemplatesStream
()
throws
GitLabApiException
{
return
(
getLicenseTemplates
(
false
,
getDefaultPerPage
()).
stream
());
}
/**
* Get a Pager of all license templates.
*
* <pre><code>GitLab Endpoint: GET /templates/licenses</code></pre>
*
* @param itemsPerPage the number of LicenseTemplate instances that will be fetched per page
* @return a Pager of license template
* @throws GitLabApiException if any exception occurs
*/
public
Pager
<
LicenseTemplate
>
getLicenseTemplates
(
int
itemsPerPage
)
throws
GitLabApiException
{
return
(
getLicenseTemplates
(
false
,
itemsPerPage
));
}
/**
* Get a List of popular license templates.
*
* <pre><code>GitLab Endpoint: GET /templates/licenses?popular=true</code></pre>
*
* @return a list of popular LicenseTemplate instances
* @throws GitLabApiException if any exception occurs
*/
public
List
<
LicenseTemplate
>
getPopularLicenseTemplates
()
throws
GitLabApiException
{
return
(
getLicenseTemplates
(
true
,
getDefaultPerPage
()).
all
());
}
/**
* Get a Stream of popular license templates.
*
* <pre><code>GitLab Endpoint: GET /templates/licenses?popular=true</code></pre>
*
* @return a Stream of popular LicenseTemplate instances
* @throws GitLabApiException if any exception occurs
*/
public
Stream
<
LicenseTemplate
>
getPopularLicenseTemplatesStream
()
throws
GitLabApiException
{
return
(
getLicenseTemplates
(
true
,
getDefaultPerPage
()).
stream
());
}
/**
* Get a Pager of license templates.
*
* <pre><code>GitLab Endpoint: GET /templates/licenses</code></pre>
*
* @param popular if true, returns only popular licenses.
* @param itemsPerPage the number of LicenseTemplate instances that will be fetched per page
* @return a Pager of license template
* @throws GitLabApiException if any exception occurs
*/
public
Pager
<
LicenseTemplate
>
getLicenseTemplates
(
Boolean
popular
,
int
itemsPerPage
)
throws
GitLabApiException
{
GitLabApiForm
formData
=
new
GitLabApiForm
().
withParam
(
"popular"
,
popular
);
return
(
new
Pager
<
LicenseTemplate
>(
this
,
LicenseTemplate
.
class
,
itemsPerPage
,
formData
.
asMap
(),
"templates"
,
"licenses"
));
}
/**
* Get a single license template.
*
* <pre><code>GitLab Endpoint: GET /templates/licenses/:key</code></pre>
*
* @param key The key of the license template
* @return a LicenseTemplate instance
* @throws GitLabApiException if any exception occurs
*/
public
LicenseTemplate
getLicenseTemplate
(
String
key
)
throws
GitLabApiException
{
Response
response
=
get
(
Response
.
Status
.
OK
,
null
,
"licenses"
,
key
);
return
(
response
.
readEntity
(
LicenseTemplate
.
class
));
}
/**
* Get a single license template as the value of an Optional.
*
* <pre><code>GitLab Endpoint: GET /templates/licenses/:key</code></pre>
*
* @param key The key of the license template
* @return a single license template as the value of an Optional.
* @throws GitLabApiException if any exception occurs
*/
public
Optional
<
LicenseTemplate
>
getOptionalLicenseTemplate
(
String
key
)
{
try
{
return
(
Optional
.
ofNullable
(
getLicenseTemplate
(
key
)));
}
catch
(
GitLabApiException
glae
)
{
return
(
GitLabApi
.
createOptionalFromException
(
glae
));
}
}
}
\ No newline at end of file
src/main/java/org/gitlab4j/api/LicensesApi.java
deleted
100644 → 0
View file @
9562a702
package
org.gitlab4j.api
;
import
java.util.List
;
import
javax.ws.rs.core.Form
;
import
javax.ws.rs.core.GenericType
;
import
javax.ws.rs.core.Response
;
import
org.gitlab4j.api.models.LicenseTemplate
;
/**
* This class provides an entry point to all the GitLab API licenses calls.
*/
public
class
LicensesApi
extends
AbstractApi
{
public
LicensesApi
(
GitLabApi
gitLabApi
)
{
super
(
gitLabApi
);
}
/**
* Get all license templates.
*
* GET /licenses
*
* @return a list of LicenseTemplate instances
* @throws GitLabApiException if any exception occurs
*/
public
List
<
LicenseTemplate
>
getAllLicenseTemplates
()
throws
GitLabApiException
{
Response
response
=
get
(
Response
.
Status
.
OK
,
null
,
"licenses"
);
return
(
response
.
readEntity
(
new
GenericType
<
List
<
LicenseTemplate
>>()
{}));
}
/**
* Get popular license templates.
*
* GET /licenses
*
* @return a list of LicenseTemplate instances
* @throws GitLabApiException if any exception occurs
*/
public
List
<
LicenseTemplate
>
getPopularLicenseTemplates
()
throws
GitLabApiException
{
Form
formData
=
new
GitLabApiForm
().
withParam
(
"popular"
,
true
,
true
);
Response
response
=
get
(
Response
.
Status
.
OK
,
formData
.
asMap
(),
"licenses"
);
return
(
response
.
readEntity
(
new
GenericType
<
List
<
LicenseTemplate
>>()
{}));
}
/**
* Get a single license template.
*
* GET /licenses
*
* @param key The key of the license template
* @return a LicenseTemplate instance
* @throws GitLabApiException if any exception occurs
*/
public
LicenseTemplate
getSingleLicenseTemplate
(
String
key
)
throws
GitLabApiException
{
Response
response
=
get
(
Response
.
Status
.
OK
,
null
,
"licenses"
,
key
);
return
(
response
.
readEntity
(
LicenseTemplate
.
class
));
}
}
\ No newline at end of file
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment