Package com.rednit.tinder4j.api.entities.user

Class GenericUser

java.lang.Object

com.rednit.tinder4j.api.entities.Entity

com.rednit.tinder4j.api.entities.user.GenericUser

Direct Known Subclasses:

MatchedUser, SelfUser, SwipeableUser

public abstract class GenericUser
extends Entity

Abstract top level class for users.

Since:

1.0.0

Version:

1.0.0

Author:

Kaktushose

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GenericUser(DataObject user, TinderClient client)	Constructs a new GenericUser.

Method Summary

Modifier and Type	Method	Description
int	getAge()	Gets the age of the user.
List<String>	getBadges()	Gets a possibly empty List the badges the user has.
String	getBio()	Gets the bio of the user.
String	getBirthdate()	Gets the users' birthdate.
Gender	getGender()	Gets the Gender of the user.
String	getName()	Gets the name of the user.
List<GenericPhoto>	getPhotos()	Gets a List of GenericPhotos of the user.
RestAction<UserProfile>	getUserProfile()	Gets the UserProfile.
boolean	hasBadges()	Whether this user has badges.
RestAction<Void>	report(String cause, String text)	Reports the user.
String	toString()

Methods inherited from class com.rednit.tinder4j.api.entities.Entity

getClient, getId

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericUser

protected GenericUser(DataObject user,
                      TinderClient client)

Constructs a new GenericUser.

Parameters:

user - the DataObject to construct the GenericUser from

client - the corresponding TinderClient instance

Method Detail

getUserProfile

public RestAction<UserProfile> getUserProfile()

Gets the UserProfile. A UserProfile contains all available information about a user, while this class and its subtypes may only contain certain information.

Returns:

the UserProfile wrapped in a RestAction

report

public RestAction<Void> report(String cause,
                               String text)

Reports the user.

Parameters:

cause - the report cause

text - the detailed report text

Returns:

RestAction

getBio

public String getBio()

Gets the bio of the user.

Returns:

the bio of the user

getBirthdate

public String getBirthdate()

Gets the users' birthdate. Note: This does only display the real birthdate if it's the SelfUser.

Returns:

the users' birthdate

getAge

public int getAge()

Gets the age of the user. Uses getBirthdate() to calculate the age.

Returns:

the age of the user

Throws:

UnsupportedOperationException - if the birthdate is not available

getName

public String getName()

Gets the name of the user.

Returns:

the name of the user

getGender

public Gender getGender()

Gets the Gender of the user.

Returns:

the Gender of the user.

hasBadges

public boolean hasBadges()

Whether this user has badges.

Returns:

true if this user has badges

See Also:

()

getBadges

public List<String> getBadges()

Gets a possibly empty List the badges the user has.

Returns:

a possibly empty List the badges

getPhotos

public List<GenericPhoto> getPhotos()

Gets a List of GenericPhotos of the user.

Returns:

a List of GenericPhotos

toString

public String toString()

Overrides:

toString in class Entity