com.jagrosh.jdautilities.commons.utils

Class SafeIdUtil

java.lang.Object

com.jagrosh.jdautilities.commons.utils.SafeIdUtil

public final class SafeIdUtil
extends java.lang.Object

A Utilities class for safely checking and converting String IDs to longs usable with MiscUtil.parseSnowflake(String), a utility used in several Object#getXById(String) methods.

This class contains two static methods:

• SafeIdUtil.safeConvert(String) - Safely converts a String to a format usable with MiscUtil.parseSnowflake(String).
• SafeIdUtil.checkId(String) - Checks if a String is safe to use with MiscUtil.parseSnowflake(String) as it is.

Since:

1.2

Author:

Kaidan Gustave

Method Summary

Modifier and Type	Method and Description
static boolean	checkId(java.lang.String id) Checks if the provided String ID is usable with MiscUtil.parseSnowflake(String).
static long	safeConvert(java.lang.String id) Safely convert the provided String ID to a long usable with MiscUtil.parseSnowflake(String).

Methods inherited from class java.lang.Object

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

Method Detail

safeConvert

public static long safeConvert(java.lang.String id)

Safely convert the provided String ID to a long usable with MiscUtil.parseSnowflake(String).

Parameters:

id - The String ID to be converted

Returns:

If the String can be converted into a non-negative long, then it will return the conversion.
However, if one of the following criteria is met, then this method will return 0L:

• If the provided String throws a NumberFormatException when used with Long.parseLong(String).
• If the provided String is converted, but the returned long is negative.

checkId

public static boolean checkId(java.lang.String id)

Checks if the provided String ID is usable with MiscUtil.parseSnowflake(String).

Parameters:

id - The String ID to be converted

Returns:

true if both of the following criteria are not met:

• If the provided String throws a NumberFormatException when used with Long.parseLong(String).
• If the provided String is converted, but the returned long is negative.