Package io.github.coho04.githubapi.entities

Class GHProject

java.lang.Object

io.github.coho04.githubapi.bases.GHBase

io.github.coho04.githubapi.bases.ClassBase

io.github.coho04.githubapi.entities.GHProject

All Implemented Interfaces:

HttpRequestInterface, JSONHelper

public class GHProject
extends ClassBase

GHProject is a class that extends ClassBase. It represents a GitHub project. It contains several properties such as ownerUrl, columnsUrl, name, body, number, state, creator, createdAt, updatedAt, organizationPermission, and isPrivate. These properties are initialized through a JSONObject.

Since:

2024-1.2

Version:

1.0

Author:

Coho04

Nested Class Summary

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

JSONHelper.JSONToObject<T>

Constructor Summary

Constructors

Constructor	Description
GHProject(Github github, org.json.JSONObject jsonObject)	Constructs a new GHProject object.

Method Summary

Modifier and Type	Method	Description
String	getBody()	Returns the body of this GHProject object.
String	getColumnsUrl()	Returns the columnsUrl of this GHProject object.
OffsetDateTime	getCreatedAt()	Returns the createdAt time of this GHProject object.
GHUser	getCreator()	Returns the creator of this GHProject object.
String	getName()	Returns the name of this GHProject object.
int	getNumber()	Returns the number of this GHProject object.
String	getOrganizationPermission()	Returns the organizationPermission of this GHProject object.
String	getOwnerUrl()	Returns the ownerUrl of this GHProject object.
String	getState()	Returns the state of this GHProject object.
OffsetDateTime	getUpdatedAt()	Returns the updatedAt time of this GHProject object.
boolean	isPrivate()	Returns the isPrivate of this GHProject object.

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

getEventsUrl, getHtmlUrl, getId, getNodeId, getUrl, toJSONObject

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

fetchArrayData, fetchArrayData, fetchPaginatedData, fetchPaginatedData, fetchPaginatedData, getBaseUrl

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

GHProject

public GHProject(Github github,
 org.json.JSONObject jsonObject)

Constructs a new GHProject object.

Parameters:

jsonObject - a JSONObject containing the data for initializing the GHProject object.

Method Details

getName

public String getName()

Returns the name of this GHProject object.

Returns:

the name of this GHProject object.

getCreator

public GHUser getCreator()

Returns the creator of this GHProject object.

Returns:

the creator of this GHProject object.

getNumber

public int getNumber()

Returns the number of this GHProject object.

Returns:

the number of this GHProject object.

getBody

public String getBody()

Returns the body of this GHProject object.

Returns:

the body of this GHProject object.

getColumnsUrl

public String getColumnsUrl()

Returns the columnsUrl of this GHProject object.

Returns:

the columnsUrl of this GHProject object.

getCreatedAt

public OffsetDateTime getCreatedAt()

Returns the createdAt time of this GHProject object.

Returns:

the createdAt time of this GHProject object.

getOrganizationPermission

public String getOrganizationPermission()

Returns the organizationPermission of this GHProject object.

Returns:

the organizationPermission of this GHProject object.

getOwnerUrl

public String getOwnerUrl()

Returns the ownerUrl of this GHProject object.

Returns:

the ownerUrl of this GHProject object.

getState

public String getState()

Returns the state of this GHProject object.

Returns:

the state of this GHProject object.

getUpdatedAt

public OffsetDateTime getUpdatedAt()

Returns the updatedAt time of this GHProject object.

Returns:

the updatedAt time of this GHProject object.

isPrivate

public boolean isPrivate()

Returns the isPrivate of this GHProject object.

Returns:

the isPrivate of this GHProject object.