Files
runelite/runelite-api/src/main/java/net/runelite/api/ClanMemberRank.java
2019-06-07 23:54:32 -04:00

107 lines
2.5 KiB
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 clan members.
*/
@AllArgsConstructor
@Getter
public enum ClanMemberRank
{
/**
* Not in a clan.
*/
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, ClanMemberRank> RANKS = new HashMap<>();
static
{
for (final ClanMemberRank clanMemberRank : ClanMemberRank.values())
{
RANKS.put(clanMemberRank.value, clanMemberRank);
}
}
/**
* Utility method that maps the rank value to its respective
* {@link ClanMemberRank} value.
*
* @param rank the rank value
* @return rank type
*/
public static ClanMemberRank valueOf(int rank)
{
return RANKS.get(rank);
}
/**
* The value of the clan rank.
*/
private final int value;
}