-
-
Notifications
You must be signed in to change notification settings - Fork 723
/
ISnowflake.java
61 lines (55 loc) · 1.74 KB
/
ISnowflake.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
/*
* Copyright 2015 Austin Keener, Michael Ritter, Florian Spieß, and the JDA contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.dv8tion.jda.api.entities;
import net.dv8tion.jda.api.utils.TimeUtil;
import javax.annotation.Nonnull;
import java.time.OffsetDateTime;
/**
* Marks a snowflake entity. Snowflake entities are ones that have an id that uniquely identifies them.
*
* @since 3.0
*/
public interface ISnowflake
{
/**
* The Snowflake id of this entity. This is unique to every entity and will never change.
*
* @return Never-null String containing the Id.
*/
@Nonnull
default String getId()
{
return Long.toUnsignedString(getIdLong());
}
/**
* The Snowflake id of this entity. This is unique to every entity and will never change.
*
* @return Long containing the Id.
*/
long getIdLong();
/**
* The time this entity was created. Calculated through the Snowflake in {@link #getIdLong}.
*
* @return OffsetDateTime - Time this entity was created at.
*
* @see TimeUtil#getTimeCreated(long)
*/
@Nonnull
default OffsetDateTime getTimeCreated()
{
return TimeUtil.getTimeCreated(getIdLong());
}
}