org.kohsuke.github

Class GHLicense

java.lang.Object

org.kohsuke.github.GHObject

org.kohsuke.github.GHLicense

Deprecated.

@Preview
 @Deprecated
public class GHLicense
extends GHObject

The GitHub Preview API's license information

WARNING: This uses a PREVIEW API - subject to change.

Author:

Duncan Dickinson

See Also:

GitHub.getLicense(String), GHRepository.getLicense(), https://developer.github.com/v3/licenses/

Field Summary

Fields

Modifier and Type	Field and Description
protected String	body Deprecated.
protected String	category Deprecated.
protected String	description Deprecated.
protected Boolean	featured Deprecated.
protected List<String>	forbidden Deprecated.
protected String	html_url Deprecated.
protected String	implementation Deprecated.
protected String	key Deprecated.
protected String	name Deprecated.
protected List<String>	permitted Deprecated.
protected List<String>	required Deprecated.

Fields inherited from class org.kohsuke.github.GHObject

created_at, id, updated_at, url

Constructor Summary

Constructors

Constructor and Description
GHLicense() Deprecated.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Deprecated.
String	getBody() Deprecated.
String	getCategory() Deprecated.
String	getDescription() Deprecated.
List<String>	getForbidden() Deprecated.
URL	getHtmlUrl() Deprecated. URL of this object for humans, which renders some HTML.
String	getImplementation() Deprecated.
String	getKey() Deprecated.
String	getName() Deprecated.
List<String>	getPermitted() Deprecated.
List<String>	getRequired() Deprecated.
URL	getUrl() Deprecated. API URL of this object.
int	hashCode() Deprecated.
Boolean	isFeatured() Deprecated. Featured licenses are bold in the new repository drop-down
protected void	populate() Deprecated. Fully populate the data by retrieving missing data.

Methods inherited from class org.kohsuke.github.GHObject

getCreatedAt, getId, getUpdatedAt, toString

Methods inherited from class java.lang.Object

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

Field Detail

key

protected String key

Deprecated.

name

protected String name

Deprecated.

featured

protected Boolean featured

Deprecated.

html_url

protected String html_url

Deprecated.

description

protected String description

Deprecated.

category

protected String category

Deprecated.

implementation

protected String implementation

Deprecated.

body

protected String body

Deprecated.

required

protected List<String> required

Deprecated.

permitted

protected List<String> permitted

Deprecated.

forbidden

protected List<String> forbidden

Deprecated.

Constructor Detail

GHLicense

public GHLicense()

Deprecated.

Method Detail

getKey

public String getKey()

Deprecated.

Returns:

a mnemonic for the license

getName

public String getName()

Deprecated.

Returns:

the license name

getUrl

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

Deprecated.

Description copied from class: GHObject

API URL of this object.

Overrides:

getUrl in class GHObject

Returns:

API URL of this object.

isFeatured

public Boolean isFeatured()
                   throws IOException

Deprecated.

Featured licenses are bold in the new repository drop-down

Returns:

True if the license is featured, false otherwise

Throws:

IOException

getHtmlUrl

public URL getHtmlUrl()
               throws IOException

Deprecated.

Description copied from class: GHObject

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

Specified by:

getHtmlUrl in class GHObject

Throws:

IOException

getDescription

public String getDescription()
                      throws IOException

Deprecated.

Throws:

IOException

getCategory

public String getCategory()
                   throws IOException

Deprecated.

Throws:

IOException

getImplementation

public String getImplementation()
                         throws IOException

Deprecated.

Throws:

IOException

getRequired

public List<String> getRequired()
                         throws IOException

Deprecated.

Throws:

IOException

getPermitted

public List<String> getPermitted()
                          throws IOException

Deprecated.

Throws:

IOException

getForbidden

public List<String> getForbidden()
                          throws IOException

Deprecated.

Throws:

IOException

getBody

public String getBody()
               throws IOException

Deprecated.

Throws:

IOException

populate

protected void populate()
                 throws IOException

Deprecated.

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

equals

public boolean equals(Object o)

Deprecated.

Overrides:

equals in class Object

hashCode

public int hashCode()

Deprecated.

Overrides:

hashCode in class Object