teozfrank.ultimatevotes.util

Class UltimateVotesAPI

java.lang.Object

teozfrank.ultimatevotes.util.UltimateVotesAPI

public class UltimateVotesAPI
extends java.lang.Object

Copyright teozfrank / FJFreelance 2014-2020 All rights reserved.

Constructor Summary

Constructors

Constructor and Description
UltimateVotesAPI()

Method Summary

Modifier and Type	Method and Description
static java.lang.Long	getLastUpdatedTime() get the last time the cached values were updated from the database
java.util.ArrayList<java.util.UUID>	getListOfPlayersWhoHaveNotVotedToday() hooks into the plugins way of keeping track of the list of online players that have note voted today requires no need to access the database safe to use in sync with the main server thread
java.util.ArrayList<java.util.UUID>	getListOfPlayersWhoHaveVotedToday() hooks into the plugins way of keeping track of the list of online players that have voted today requires no need to access the database safe to use in sync with the main server thread
static int	getPlayerAllTimeVotes(java.lang.String playername) get the players total votes in total accesses the database, should be called async, not on the main server thread!
static int	getPlayerAllTimeVotes(java.util.UUID playerUUID) get the players total votes in total accesses the database, should be called async, not on the main server thread!
static int	getPlayerMonthlyVotes(java.lang.String playername) get the players vote count by username accesses the database, should be called async, not on the main server thread!
static int	getPlayerMonthlyVotes(java.util.UUID playerUUID) get the players monthly votes count accesses the database, should be called async, not on the main server thread!
static int	getPlayerTotalVotes(java.lang.String playername) Deprecated.
static int	getPlayerTotalVotes(java.util.UUID playerUUID) Deprecated.
static int	getPlayerUnclaimedVotes(java.util.UUID playerUUID) Get the players unclaimed vote count
static java.util.LinkedHashMap<java.lang.String,java.lang.Integer>	getTopPlayers() Deprecated.
static java.util.LinkedHashMap<java.lang.String,java.lang.Integer>	getTopPlayersCached() Deprecated.
static java.util.LinkedHashMap<java.lang.String,java.lang.Integer>	getTopVotersAllTime() get the top 10 voters all time from the database accesses the database, should be called async, not on the main server thread!
static java.util.LinkedHashMap<java.lang.String,java.lang.Integer>	getTopVotersAllTime(int limit) get the top all time voters based on a limit passed in accesses the database, should be called async, not on the main server thread!
static java.util.LinkedHashMap<java.lang.String,java.lang.Integer>	getTopVotersAllTimeCached() get the top 10 all time voters from the cached value from the database
static java.util.LinkedHashMap<java.lang.String,java.lang.Integer>	getTopVotersMonthly() get the top 10 voters from the database accesses the database, should be called async, not on the main server thread!
static java.util.LinkedHashMap<java.lang.String,java.lang.Integer>	getTopVotersMonthly(int limit) get the top monthly voters based on a limit passed in accesses the database, should be called async, not on the main server thread!
static java.util.LinkedHashMap<java.lang.String,java.lang.Integer>	getTopVotersMonthlyCached() get the top 10 monthly voters from the cached value from the database
static boolean	hasVotedToday(java.lang.String playername) has the player voted today accesses the database, should be called async, not on the main server thread!
static boolean	hasVotedToday(java.util.UUID playerUUID) has the player voted today accesses the database, should be called async, not on the main server thread!
static boolean	hasVotedTodayCached(java.util.UUID playerUUID) hooks into the plugins way of keeping track of if a player has voted today requires no need to access the database safe to use in sync with the main server thread
static java.sql.ResultSet	performDatabaseQuery(java.lang.String query) perform a mysql query on the database of ultimatevotes please remember the structure of the database can change breaking code relying on this, please only use this as as last resort for something the API does not provide accesses the database, should be called async, not on the main server thread!

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UltimateVotesAPI

public UltimateVotesAPI()

Method Detail

getPlayerMonthlyVotes

public static int getPlayerMonthlyVotes(java.util.UUID playerUUID)

get the players monthly votes count accesses the database, should be called async, not on the main server thread!

Parameters:

playerUUID - the players UUID

Returns:

the amount of votes a player has for this month

getPlayerUnclaimedVotes

public static int getPlayerUnclaimedVotes(java.util.UUID playerUUID)

Get the players unclaimed vote count

Parameters:

playerUUID - the players UUID

Returns:

the amount of unclaimed votes the player has for this month

getPlayerMonthlyVotes

public static int getPlayerMonthlyVotes(java.lang.String playername)

get the players vote count by username accesses the database, should be called async, not on the main server thread!

Parameters:

playername - the players username

Returns:

the amount of votes a player has for this month

getPlayerAllTimeVotes

public static int getPlayerAllTimeVotes(java.util.UUID playerUUID)

get the players total votes in total accesses the database, should be called async, not on the main server thread!

Parameters:

playerUUID - the players UUID

Returns:

the amount of votes a player has in total

getPlayerAllTimeVotes

public static int getPlayerAllTimeVotes(java.lang.String playername)

get the players total votes in total accesses the database, should be called async, not on the main server thread!

Parameters:

playername - the players username

Returns:

the amount of votes a player has in total

hasVotedToday

public static boolean hasVotedToday(java.util.UUID playerUUID)

has the player voted today accesses the database, should be called async, not on the main server thread!

Parameters:

playerUUID - the player UUID

Returns:

true if they have voted, false if not

hasVotedTodayCached

public static boolean hasVotedTodayCached(java.util.UUID playerUUID)

hooks into the plugins way of keeping track of if a player has voted today requires no need to access the database safe to use in sync with the main server thread

Parameters:

playerUUID - the player uuid to check if they have voted today

Returns:

true if they have voted today, false if not

getListOfPlayersWhoHaveVotedToday

public java.util.ArrayList<java.util.UUID> getListOfPlayersWhoHaveVotedToday()

hooks into the plugins way of keeping track of the list of online players that have voted today requires no need to access the database safe to use in sync with the main server thread

Returns:

a list of online player uuids that have voted today

getListOfPlayersWhoHaveNotVotedToday

public java.util.ArrayList<java.util.UUID> getListOfPlayersWhoHaveNotVotedToday()

hooks into the plugins way of keeping track of the list of online players that have note voted today requires no need to access the database safe to use in sync with the main server thread

Returns:

a list of online player uuids that have not voted today

hasVotedToday

public static boolean hasVotedToday(java.lang.String playername)

has the player voted today accesses the database, should be called async, not on the main server thread!

Parameters:

playername - the players username

Returns:

true if they have voted, false if not

getTopVotersMonthly

public static java.util.LinkedHashMap<java.lang.String,java.lang.Integer> getTopVotersMonthly()

get the top 10 voters from the database accesses the database, should be called async, not on the main server thread!

Returns:

the top 10 voters from the database

getTopVotersAllTime

public static java.util.LinkedHashMap<java.lang.String,java.lang.Integer> getTopVotersAllTime()

get the top 10 voters all time from the database accesses the database, should be called async, not on the main server thread!

Returns:

the top 10 voters all time from the database

getTopVotersMonthly

public static java.util.LinkedHashMap<java.lang.String,java.lang.Integer> getTopVotersMonthly(int limit)

get the top monthly voters based on a limit passed in accesses the database, should be called async, not on the main server thread!

Parameters:

limit - the limit of the top voters

Returns:

a linked hashmap of the top players

getTopVotersAllTime

public static java.util.LinkedHashMap<java.lang.String,java.lang.Integer> getTopVotersAllTime(int limit)

get the top all time voters based on a limit passed in accesses the database, should be called async, not on the main server thread!

Parameters:

limit - the limit of the top voters

Returns:

a linked hashmap of the top players

performDatabaseQuery

public static java.sql.ResultSet performDatabaseQuery(java.lang.String query)

perform a mysql query on the database of ultimatevotes please remember the structure of the database can change breaking code relying on this, please only use this as as last resort for something the API does not provide accesses the database, should be called async, not on the main server thread!

Parameters:

query - the mysql query

Returns:

the resulting resultset of the database query

getTopVotersMonthlyCached

public static java.util.LinkedHashMap<java.lang.String,java.lang.Integer> getTopVotersMonthlyCached()

get the top 10 monthly voters from the cached value from the database

Returns:

the top 10 monthly voters from the cached value

getTopVotersAllTimeCached

public static java.util.LinkedHashMap<java.lang.String,java.lang.Integer> getTopVotersAllTimeCached()

get the top 10 all time voters from the cached value from the database

Returns:

the top 10 monthly voters from the cached value

getLastUpdatedTime

public static java.lang.Long getLastUpdatedTime()

get the last time the cached values were updated from the database

Returns:

the time in long format

getPlayerTotalVotes

@Deprecated
public static int getPlayerTotalVotes(java.util.UUID playerUUID)

Deprecated.

get the players total votes in total

Parameters:

playerUUID - the players UUID

Returns:

the amount of votes a player has in total

getPlayerTotalVotes

@Deprecated
public static int getPlayerTotalVotes(java.lang.String playername)

Deprecated.

get the players total votes in total

Parameters:

playername - the players username

Returns:

the amount of votes a player has in total

getTopPlayers

@Deprecated
public static java.util.LinkedHashMap<java.lang.String,java.lang.Integer> getTopPlayers()

Deprecated.

get the top 10 voters from the database

Returns:

the top 10 voters from the database

getTopPlayersCached

@Deprecated
public static java.util.LinkedHashMap<java.lang.String,java.lang.Integer> getTopPlayersCached()

Deprecated.

get the top 10 voters from the cached value from the database

Returns:

the top 10 voters from the cached value