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
protected String	category
protected String	description
protected Boolean	featured
protected List<String>	forbidden
protected String	html_url
protected String	implementation
protected String	key
protected String	name
protected List<String>	permitted
protected List<String>	required

Fields inherited from class org.kohsuke.github.GHObject

created_at, id, responseHeaderFields, updated_at, url

Constructor Summary

Constructors

Constructor	Description
GHLicense()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getBody()	Gets body.
String	getCategory()	Gets category.
String	getDescription()	Gets description.
List<String>	getForbidden()	Gets forbidden.
URL	getHtmlUrl()	Gets html url.
String	getImplementation()	Gets implementation.
String	getKey()	Gets key.
String	getName()	Gets name.
List<String>	getPermitted()	Gets permitted.
List<String>	getRequired()	Gets required.
URL	getUrl()	Gets url.
int	hashCode()
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, getResponseHeaderFields, getUpdatedAt, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

key

protected String key

name

protected String name

featured

protected Boolean featured

html_url

protected String html_url

description

protected String description

category

protected String category

implementation

protected String implementation

body

protected String body

required

protected List<String> required

permitted

protected List<String> permitted

forbidden

protected List<String> forbidden

Constructor Detail

GHLicense

public GHLicense()

Method Detail

getKey

public String getKey()

Gets key.

Returns:

a mnemonic for the license

getName

public String getName()

Gets name.

Returns:

the license name

getUrl

@WithBridgeMethods(value=java.lang.String.class,
                   adapterMethod="urlToString")
public URL getUrl()

Description copied from class: GHObject

Gets url.

Overrides:

getUrl in class GHObject

Returns:

API URL of this object.

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

Description copied from class: GHObject

Gets html url.

Specified by:

getHtmlUrl in class GHObject

Returns:

URL of this object for humans, which renders some HTML.

Throws:

IOException - on error

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)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object