Package io.github.thecsdev.tcdcommons.api.util.io.repo

Class RepositoryHostInfo

java.lang.Object

io.github.thecsdev.tcdcommons.api.util.io.repo.RepositoryHostInfo

Direct Known Subclasses:

GitHubHostInfo

public abstract class RepositoryHostInfo
extends Object

Provides information about a repository hosting platform.

Constructor Summary

Constructors

Constructor	Description
RepositoryHostInfo()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
abstract RepositoryInfo	fetchRepoInfoByIdSync(String repoId)	Synchronously fetches RepositoryInfo about a given repository, using the repository's unique ID.
abstract RepositoryUserInfo	fetchUserInfoByIdSync(String userId)	Synchronously fetches RepositoryUserInfo about a given user, using the user's unique ID.
abstract @Nullable URL	getApiURL()	Returns the URL that points to the repository host's APIs, or null, if the repository host does not have an API.
abstract String	getDisplayName()	Returns the user-friendly display name of the platform.
String	getID()	Returns a String that represents the "unique identifier" for this repository hosting platform.
abstract URL	getURL()	Returns the URL that represents where the hosting platform is located.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Details

RepositoryHostInfo

public RepositoryHostInfo()

Method Details

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getID

public String getID()

Returns a String that represents the "unique identifier" for this repository hosting platform. By default, this is URL.getHost().

getURL

public abstract URL getURL()

Returns the URL that represents where the hosting platform is located.

getApiURL

@Nullable
public abstract @Nullable URL getApiURL()

Returns the URL that points to the repository host's APIs, or null, if the repository host does not have an API.

getDisplayName

public abstract String getDisplayName()

Returns the user-friendly display name of the platform.

fetchUserInfoByIdSync

public abstract RepositoryUserInfo fetchUserInfoByIdSync(String userId)
                                                  throws UnsupportedOperationException,
NullPointerException,
IOException

Synchronously fetches RepositoryUserInfo about a given user, using the user's unique ID.

Parameters:

userId - The String representation of the user's unique ID.

Throws:

UnsupportedOperationException

NullPointerException

IOException

See Also:

• RepositoryUserInfo.getID()

fetchRepoInfoByIdSync

public abstract RepositoryInfo fetchRepoInfoByIdSync(String repoId)
                                              throws UnsupportedOperationException,
NullPointerException,
IOException

Synchronously fetches RepositoryInfo about a given repository, using the repository's unique ID.

Parameters:

repoId - The String representation of the repository's unique ID.

Throws:

UnsupportedOperationException

NullPointerException

IOException

See Also:

• RepositoryInfo.getID()