Package dev.getelements.elements.sdk.model.friend

Enum Class Friendship

java.lang.Object

java.lang.Enum<Friendship>

dev.getelements.elements.sdk.model.friend.Friendship

All Implemented Interfaces:

Serializable, Comparable<Friendship>, Constable

public enum Friendship
extends Enum<Friendship>

Represents the type of relationship the user has with another user.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INCOMING	The other user has requested friendshipb, this user has not accepted the friendship.
MUTUAL	Both users have accepted friendship.
NONE	No friendship whatsoever.
OUTGOING	The user has requested friendship from the other user, but the other user has not accepted the request for friendship.

Method Summary

Modifier and Type	Method	Description
static Friendship	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Friendship[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final Friendship NONE

No friendship whatsoever.

OUTGOING

public static final Friendship OUTGOING

The user has requested friendship from the other user, but the other user has not accepted the request for friendship.

INCOMING

public static final Friendship INCOMING

The other user has requested friendshipb, this user has not accepted the friendship.

MUTUAL

public static final Friendship MUTUAL

Both users have accepted friendship.

Method Details

values

public static Friendship[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Friendship valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null