org.telegram.abilitybots.api.objects

Class EndUser

java.lang.Object

org.telegram.abilitybots.api.objects.EndUser

All Implemented Interfaces:

Serializable

public final class EndUser
extends Object
implements Serializable

This class serves the purpose of separating the basic Telegram User and the augmented EndUser.

It adds proper hashCode, equals, toString as well as useful utility methods such as shortName() and fullName().

Author:

Abbas Abou Daya

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static EndUser	endUser(Integer id, String firstName, String lastName, String username)
boolean	equals(Object o)
String	firstName()
static EndUser	fromUser(org.telegram.telegrambots.api.objects.User user) Constructs an EndUser from a User.
String	fullName() The full name is identified as the concatenation of the first and last name, separated by a space.
int	hashCode()
int	id()
String	lastName()
String	shortName() The short name is one of the following: First name Last name Username The method will try to return the first valid name in the specified order.
String	toString()
String	username()

Methods inherited from class java.lang.Object

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

Method Detail

endUser

public static EndUser endUser(Integer id,
                              String firstName,
                              String lastName,
                              String username)

fromUser

public static EndUser fromUser(org.telegram.telegrambots.api.objects.User user)

Constructs an EndUser from a User.

Parameters:

user - the Telegram user

Returns:

an augmented end-user

id

public int id()

firstName

public String firstName()

lastName

public String lastName()

username

public String username()

fullName

public String fullName()

The full name is identified as the concatenation of the first and last name, separated by a space. This method can return an empty name if both first and last name are empty.

Returns:

the full name of the user

shortName

public String shortName()

The short name is one of the following:

1. First name
2. Last name
3. Username

The method will try to return the first valid name in the specified order.

Returns:

the short name of the user

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object