FriendsChatRank.java

/*
 * Copyright (c) 2016-2017, Adam <Adam@sigterm.info>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package net.runelite.api;

import java.util.HashMap;
import java.util.Map;
import lombok.AllArgsConstructor;
import lombok.Getter;

/**
 * An enumeration of ranks of friends chat members.
 */
@AllArgsConstructor
@Getter
public enum FriendsChatRank
{
	/**
	 * Not ranked.
	 */
	UNRANKED(-1),
	/**
	 * Friend rank.
	 */
	FRIEND(0),
	/**
	 * Recruit rank.
	 */
	RECRUIT(1),
	/**
	 * Corporal rank.
	 */
	CORPORAL(2),
	/**
	 * Sergeant rank.
	 */
	SERGEANT(3),
	/**
	 * Lieutenant rank.
	 */
	LIEUTENANT(4),
	/**
	 * Captain rank.
	 */
	CAPTAIN(5),
	/**
	 * General rank.
	 */
	GENERAL(6),
	/**
	 * Channel owner rank.
	 */
	OWNER(7),
	/**
	 * JMod rank.
	 */
	JMOD(127);

	private static final Map<Integer, FriendsChatRank> RANKS = new HashMap<>();

	static
	{
		for (final FriendsChatRank friendsChatRank : FriendsChatRank.values())
		{
			RANKS.put(friendsChatRank.value, friendsChatRank);
		}
	}

	/**
	 * Utility method that maps the rank value to its respective
	 * {@link FriendsChatRank} value.
	 *
	 * @param rank the rank value
	 * @return rank type
	 */
	public static FriendsChatRank valueOf(int rank)
	{
		return RANKS.get(rank);
	}

	/**
	 * The value of the rank.
	 */
	private final int value;
}