Package org.kohsuke.github
Class GHLicense
- java.lang.Object
-
- org.kohsuke.github.GHObject
-
- org.kohsuke.github.GHLicense
-
public class GHLicense extends GHObject
The GitHub Preview API's license information.- Author:
- Duncan Dickinson
- See Also:
GitHub#getLicense(String)
,GHRepository#getLicense()
, https://developer.github.com/v3/licenses/
-
-
Field Summary
Fields Modifier and Type Field Description protected String
body
The body.protected String
category
The body.protected String
description
The body.protected Boolean
featured
The featured.protected List<String>
forbidden
The forbidden.protected String
html_url
The body.protected String
implementation
The body.protected String
key
The name.protected String
name
The name.protected List<String>
permitted
The permitted.protected List<String>
required
The required.-
Fields inherited from class org.kohsuke.github.GHObject
responseHeaderFields
-
-
Constructor Summary
Constructors Constructor Description GHLicense()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
equals(Object o)
Equals.String
getBody()
Gets body.String
getCategory()
Gets category.String
getDescription()
Gets description.List<String>
getForbidden()
Gets forbidden.URL
getHtmlUrl()
Gets the html url.String
getImplementation()
Gets implementation.String
getKey()
Gets key.String
getName()
Gets name.List<String>
getPermitted()
Gets permitted.List<String>
getRequired()
Gets required.GitHub
getRoot()
Deprecated.For access to theGitHub
instance, use a local copy instead of pulling it out of objects.int
hashCode()
Hash code.Boolean
isFeatured()
Featured licenses are bold in the new repository drop-down.protected void
populate()
Fully populate the data by retrieving missing data.-
Methods inherited from class org.kohsuke.github.GHObject
getCreatedAt, getId, getNodeId, getResponseHeaderFields, getUpdatedAt, getUrl, setResponseHeaderFields, toString
-
-
-
-
Field Detail
-
key
protected String key
The name.
-
name
protected String name
The name.
-
featured
protected Boolean featured
The featured.
-
html_url
protected String html_url
The body.
-
description
protected String description
The body.
-
category
protected String category
The body.
-
implementation
protected String implementation
The body.
-
body
protected String body
The body.
-
-
Method Detail
-
getKey
public String getKey()
Gets key.- Returns:
- a mnemonic for the license
-
getName
public String getName()
Gets name.- Returns:
- the license name
-
isFeatured
public Boolean isFeatured() throws IOException
Featured licenses are bold in the new repository drop-down.- Returns:
- True if the license is featured, false otherwise
- Throws:
IOException
- the io exception
-
getHtmlUrl
public URL getHtmlUrl() throws IOException
Gets the html url.- Specified by:
getHtmlUrl
in classGHObject
- Returns:
- the html url
- Throws:
IOException
- Signals that an I/O exception has occurred.
-
getDescription
public String getDescription() throws IOException
Gets description.- Returns:
- the description
- Throws:
IOException
- the io exception
-
getCategory
public String getCategory() throws IOException
Gets category.- Returns:
- the category
- Throws:
IOException
- the io exception
-
getImplementation
public String getImplementation() throws IOException
Gets implementation.- Returns:
- the implementation
- Throws:
IOException
- the io exception
-
getRequired
public List<String> getRequired() throws IOException
Gets required.- Returns:
- the required
- Throws:
IOException
- the io exception
-
getPermitted
public List<String> getPermitted() throws IOException
Gets permitted.- Returns:
- the permitted
- Throws:
IOException
- the io exception
-
getForbidden
public List<String> getForbidden() throws IOException
Gets forbidden.- Returns:
- the forbidden
- Throws:
IOException
- the io exception
-
getBody
public String getBody() throws IOException
Gets body.- Returns:
- the body
- Throws:
IOException
- the io exception
-
populate
protected void populate() throws IOException
Fully populate the data by retrieving missing data.Depending on the original API call where this object is created, it may not contain everything.
- Throws:
IOException
- the io exception
-
equals
public boolean equals(Object o)
Equals.
-
getRoot
@Deprecated public GitHub getRoot()
Deprecated.For access to theGitHub
instance, use a local copy instead of pulling it out of objects.Get the rootGitHub
instance for this object.- Returns:
- the root
GitHub
instance
-
-