src/main/java/net/pterodactylus/sone/core/PostCache.java

   1 /*
   2  * Sone - PostCache.java - Copyright © 2010 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.core;
  19
  20 import java.util.HashMap;
  21 import java.util.Map;
  22
  23 import net.pterodactylus.sone.data.Post;
  24 import net.pterodactylus.sone.data.PostShell;
  25 import net.pterodactylus.sone.data.Shell;
  26
  27 /**
  28  * {@link Shell}-aware {@link Map} from post IDs to {@link Post}s that exchanges
  29  * an existing {@link Shell} against the real object once it’s available.
  30  *
  31  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  32  */
  33 public class PostCache {
  34
  35         /** The posts. */
  36         private final Map<String, Post> posts = new HashMap<String, Post>();
  37
  38         /**
  39          * Stores the given post in this cache. If the given post is not a
  40          * {@link Shell}, it is stored. If it is a {@link Shell} it is only stored
  41          * if there is no post stored for the ID of the given post. If the given
  42          * {@code post} is a {@link Shell}, it needs to have its
  43          * {@link PostShell#setId(java.util.UUID) ID} set!
  44          *
  45          * @param post
  46          *            The post to store
  47          */
  48         public void store(Post post) {
  49                 if (!(post instanceof Shell<?>) || !posts.containsKey(post.getId())) {
  50                         posts.put(post.getId(), post);
  51                 }
  52         }
  53
  54         /**
  55          * Returns the post with the given ID.
  56          *
  57          * @param id
  58          *            The ID of the post
  59          * @return The post with the given ID, or {@code null} if there is no post
  60          *         with the given ID
  61          */
  62         public Post get(String id) {
  63                 return posts.get(id);
  64         }
  65
  66 }