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