lol.hyper.githubreleaseapi

Class GitHubRelease

java.lang.Object

lol.hyper.githubreleaseapi.GitHubRelease

public class GitHubRelease
extends Object

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GitHubRelease(org.json.JSONObject object) Creates a release object of a certain tag on GitHub.

Method Summary

Modifier and Type	Method and Description
@NotNull String	getCreatedDate() Gets the time the release was first created on GitHub.
@NotNull String	getPublishedDate() Gets the time the release was published on GitHub.
@NotNull List<String>	getReleaseAssets() Get a list of the uploaded files on this tag version.
@NotNull String	getReleaseNotes() Gets the release notes for this tag version.
String	getReleaseURL() Gets the URL of the release.
@NotNull String	getTagVersion() Gets the tag version of this release.
boolean	isDraft() Is the release a draft?
boolean	isPreRelease() Is the release a pre-release?
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GitHubRelease

protected GitHubRelease(org.json.JSONObject object)

Creates a release object of a certain tag on GitHub.

Parameters:

object - The JSON object of the release.

Method Detail

getTagVersion

@NotNull
public @NotNull String getTagVersion()

Gets the tag version of this release.

Returns:

The tag version.

getReleaseNotes

@NotNull
public @NotNull String getReleaseNotes()

Gets the release notes for this tag version.

Returns:

A string with the release notes.

getPublishedDate

@NotNull
public @NotNull String getPublishedDate()

Gets the time the release was published on GitHub.

Returns:

A string with the date.

getCreatedDate

@NotNull
public @NotNull String getCreatedDate()

Gets the time the release was first created on GitHub.

Returns:

A string with the date.

getReleaseAssets

@NotNull
public @NotNull List<String> getReleaseAssets()

Get a list of the uploaded files on this tag version.

Returns:

A list of direct links to uploaded files.

isDraft

public boolean isDraft()

Is the release a draft?

Returns:

True/False if the release is a draft.

isPreRelease

public boolean isPreRelease()

Is the release a pre-release?

Returns:

True/False if the release is a pre-release.

getReleaseURL

public String getReleaseURL()

Gets the URL of the release.

Returns:

The URL of this release.

toString

public String toString()

Overrides:

toString in class Object