Package net.runelite.api
Enum FriendsChatRank
- java.lang.Object
-
- java.lang.Enum<FriendsChatRank>
-
- net.runelite.api.FriendsChatRank
-
- All Implemented Interfaces:
Serializable
,Comparable<FriendsChatRank>
public enum FriendsChatRank extends Enum<FriendsChatRank>
An enumeration of ranks of friends chat members.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getValue()
The value of the rank.static FriendsChatRank
valueOf(int rank)
Utility method that maps the rank value to its respectiveFriendsChatRank
value.static FriendsChatRank
valueOf(String name)
Returns the enum constant of this type with the specified name.static FriendsChatRank[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
UNRANKED
public static final FriendsChatRank UNRANKED
Not ranked.
-
FRIEND
public static final FriendsChatRank FRIEND
Friend rank.
-
RECRUIT
public static final FriendsChatRank RECRUIT
Recruit rank.
-
CORPORAL
public static final FriendsChatRank CORPORAL
Corporal rank.
-
SERGEANT
public static final FriendsChatRank SERGEANT
Sergeant rank.
-
LIEUTENANT
public static final FriendsChatRank LIEUTENANT
Lieutenant rank.
-
CAPTAIN
public static final FriendsChatRank CAPTAIN
Captain rank.
-
GENERAL
public static final FriendsChatRank GENERAL
General rank.
-
OWNER
public static final FriendsChatRank OWNER
Channel owner rank.
-
JMOD
public static final FriendsChatRank JMOD
JMod rank.
-
-
Method Detail
-
values
public static FriendsChatRank[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (FriendsChatRank c : FriendsChatRank.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static FriendsChatRank valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified nameNullPointerException
- if the argument is null
-
valueOf
public static FriendsChatRank valueOf(int rank)
Utility method that maps the rank value to its respectiveFriendsChatRank
value.- Parameters:
rank
- the rank value- Returns:
- rank type
-
getValue
public int getValue()
The value of the rank.
-
-