Create images using the core’s image builder.
[Sone.git] / src / main / java / net / pterodactylus / sone / data / Identified.java
1 /*
2  * Sone - Identified.java - Copyright © 2013 David Roden
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation, either version 3 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
16  */
17
18 package net.pterodactylus.sone.data;
19
20 import javax.annotation.Nonnull;
21
22 import com.google.common.base.Function;
23 import com.google.common.base.Optional;
24
25 /**
26  * Interface for all objects that expose an ID.
27  *
28  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
29  */
30 public interface Identified {
31
32         /** Function to extract the ID from an optional. */
33         public static final Function<Optional<? extends Identified>, Optional<String>> GET_ID = new Function<Optional<? extends Identified>, Optional<String>>() {
34
35                 @Override
36                 @Nonnull
37                 public Optional<String> apply(Optional<? extends Identified> identified) {
38                         return (identified == null) ? Optional.<String>absent() : (identified.isPresent() ? Optional.of(identified.get().getId()) : Optional.<String>absent());
39                 }
40         };
41
42         /**
43          * Returns the ID of this element.
44          *
45          * @return The ID of this element
46          */
47         public String getId();
48
49 }