sx.blah.discord.handle.obj.IIDLinkedObject Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of Discord4J Show documentation

The newest version!

/*
 *     This file is part of Discord4J.
 *
 *     Discord4J is free software: you can redistribute it and/or modify
 *     it under the terms of the GNU Lesser General Public License as published by
 *     the Free Software Foundation, either version 3 of the License, or
 *     (at your option) any later version.
 *
 *     Discord4J is distributed in the hope that it will be useful,
 *     but WITHOUT ANY WARRANTY; without even the implied warranty of
 *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *     GNU Lesser General Public License for more details.
 *
 *     You should have received a copy of the GNU Lesser General Public License
 *     along with Discord4J.  If not, see .
 */

package sx.blah.discord.handle.obj;

/**
 * An object which is uniquely identifiable by a snowflake ID.
 */
public interface IIDLinkedObject {

	/**
	 * Gets the unique snowflake ID of the object. This value is unsigned.
	 *
	 * @return The unique snowflake ID of the object.
	 */
	long getLongID();

	/**
	 * Gets the unique snowflake ID of the object.
	 *
	 * @return The unique snowflake ID of the object.
	 */
	default String getStringID() {
		return Long.toUnsignedString(getLongID());
	}
}