Verify that an invalid image causes an error.
[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
24 /**
25  * Interface for all objects that expose an ID.
26  *
27  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
28  */
29 public interface Identified {
30
31         /** Function to extract the ID from an optional. */
32         public static final Function<Identified, String> GET_ID = new Function<Identified, String>() {
33
34                 @Override
35                 @Nonnull
36                 public String apply(Identified identified) {
37                         return (identified == null) ? null : identified.getId();
38                 }
39         };
40
41         /**
42          * Returns the ID of this element.
43          *
44          * @return The ID of this element
45          */
46         public String getId();
47
48 }