Package io.github.coho04.githubapi.entities.repositories

Class GHFile

java.lang.Object

io.github.coho04.githubapi.bases.GHBase

io.github.coho04.githubapi.entities.repositories.GHFile

All Implemented Interfaces:

HttpRequestInterface, JSONHelper

public class GHFile
extends GHBase

This class represents a GitHub file. It provides methods for fetching data about the file such as its name, path, SHA, size, URLs, and type.

Nested Class Summary

Nested classes/interfaces inherited from interface io.github.coho04.githubapi.interfaces.JSONHelper

JSONHelper.JSONToObject<T>

Constructor Summary

Constructors

Constructor	Description
GHFile(org.json.JSONObject jsonObject)	Constructs a new GHFile instance with the provided JSON object.

Method Summary

Modifier and Type	Method	Description
String	getDownloadUrl()	Returns the download URL of the file.
String	getGitUrl()	Returns the Git URL of the file.
String	getHtmlUrl()	Returns the HTML URL of the file.
String	getName()	Returns the name of the file.
String	getPath()	Returns the path of the file.
String	getSha()	Returns the SHA of the file.
int	getSize()	Returns the size of the file.
String	getType()	Returns the type of the file.
String	getUrl()	Returns the URL of the file.

Methods inherited from class io.github.coho04.githubapi.bases.GHBase

fetchArrayData, fetchArrayData, fetchPaginatedData, fetchPaginatedData, fetchPaginatedData, getBaseUrl, toJSONObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.coho04.githubapi.interfaces.HttpRequestInterface

extractNextPageUrl, sendDeleteRequest, sendDeleteRequestWithResponseCode, sendGetRequest, sendGetRequestWithLinkHeader, sendGetRequestWithResponseCode, sendPatchRequest, sendPostRequest, sendPutRequest

Methods inherited from interface io.github.coho04.githubapi.interfaces.JSONHelper

getArrayOrNull, getBooleanOrNull, getIntOrNull, getJSONArrayToStringList, getJSONObjectOrNull, getLocalDateOrNull, getLongOrNull, getStringOrNull

Constructor Details

GHFile

public GHFile(org.json.JSONObject jsonObject)

Constructs a new GHFile instance with the provided JSON object.

Parameters:

jsonObject - the JSON object containing the file data

Method Details

getHtmlUrl

public String getHtmlUrl()

Returns the HTML URL of the file.

Returns:

the HTML URL of the file

getUrl

public String getUrl()

Returns the URL of the file.

Returns:

the URL of the file

getName

public String getName()

Returns the name of the file.

Returns:

the name of the file

getSize

public int getSize()

Returns the size of the file.

Returns:

the size of the file

getDownloadUrl

public String getDownloadUrl()

Returns the download URL of the file.

Returns:

the download URL of the file

getGitUrl

public String getGitUrl()

Returns the Git URL of the file.

Returns:

the Git URL of the file

getPath

public String getPath()

Returns the path of the file.

Returns:

the path of the file

getSha

public String getSha()

Returns the SHA of the file.

Returns:

the SHA of the file

getType

public String getType()

Returns the type of the file.

Returns:

the type of the file