src/main/java/net/pterodactylus/sone/data/Post.java

   1 /*
   2  * Sone - Post.java - Copyright © 2010–2020 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 static com.google.common.base.Optional.absent;
  21
  22 import java.util.Comparator;
  23
  24 import com.google.common.base.Optional;
  25 import com.google.common.base.Predicate;
  26
  27 /**
  28  * A post is a short message that a user writes in his Sone to let other users
  29  * know what is going on.
  30  */
  31 public interface Post extends Identified {
  32
  33         /** Comparator for posts, sorts descending by time. */
  34         public static final Comparator<Post> NEWEST_FIRST = new Comparator<Post>() {
  35
  36                 @Override
  37                 public int compare(Post leftPost, Post rightPost) {
  38                         return (int) Math.max(Integer.MIN_VALUE, Math.min(Integer.MAX_VALUE, rightPost.getTime() - leftPost.getTime()));
  39                 }
  40
  41         };
  42
  43         /** Filter for posts with timestamps from the future. */
  44         public static final Predicate<Post> FUTURE_POSTS_FILTER = new Predicate<Post>() {
  45
  46                 @Override
  47                 public boolean apply(Post post) {
  48                         return (post != null) && (post.getTime() <= System.currentTimeMillis());
  49                 }
  50
  51         };
  52
  53         //
  54         // ACCESSORS
  55         //
  56
  57         /**
  58          * Returns the ID of the post.
  59          *
  60          * @return The ID of the post
  61          */
  62         public String getId();
  63
  64         /**
  65          * Returns whether this post has already been loaded.
  66          *
  67          * @return {@code true} if this post has already been loaded, {@code
  68          * false} otherwise
  69          */
  70         boolean isLoaded();
  71
  72         /**
  73          * Returns the Sone this post belongs to.
  74          *
  75          * @return The Sone of this post
  76          */
  77         public Sone getSone();
  78
  79         /**
  80          * Returns the ID of the recipient {@link Sone}, or
  81          * {@link Optional#absent()} if this post does not have a recipient.
  82          *
  83          * @return The ID of the recipient, or {@link Optional#absent()}
  84          */
  85         public Optional<String> getRecipientId();
  86
  87         /**
  88          * Returns the recipient of this post, if any.
  89          *
  90          * @return The recipient of this post, or {@link Optional#absent()} if there
  91          *         is no recipient
  92          */
  93         public Optional<Sone> getRecipient();
  94
  95         /**
  96          * Returns the time of the post.
  97          *
  98          * @return The time of the post (in milliseconds since Jan 1, 1970 UTC)
  99          */
 100         public long getTime();
 101
 102         /**
 103          * Returns the text of the post.
 104          *
 105          * @return The text of the post
 106          */
 107         public String getText();
 108
 109         /**
 110          * Returns whether this post is known.
 111          *
 112          * @return {@code true} if this post is known, {@code false} otherwise
 113          */
 114         public boolean isKnown();
 115
 116         /**
 117          * Sets whether this post is known.
 118          *
 119          * @param known
 120          *            {@code true} if this post is known, {@code false} otherwise
 121          * @return This post
 122          */
 123         public Post setKnown(boolean known);
 124
 125         /**
 126          * Shell for a post that has not yet been loaded.
 127          */
 128         public static class EmptyPost implements Post {
 129
 130                 private final String id;
 131
 132                 public EmptyPost(String id) {
 133                         this.id = id;
 134                 }
 135
 136                 @Override
 137                 public String getId() {
 138                         return id;
 139                 }
 140
 141                 @Override
 142                 public boolean isLoaded() {
 143                         return false;
 144                 }
 145
 146                 @Override
 147                 public Sone getSone() {
 148                         return null;
 149                 }
 150
 151                 @Override
 152                 public Optional<String> getRecipientId() {
 153                         return absent();
 154                 }
 155
 156                 @Override
 157                 public Optional<Sone> getRecipient() {
 158                         return absent();
 159                 }
 160
 161                 @Override
 162                 public long getTime() {
 163                         return 0;
 164                 }
 165
 166                 @Override
 167                 public String getText() {
 168                         return null;
 169                 }
 170
 171                 @Override
 172                 public boolean isKnown() {
 173                         return false;
 174                 }
 175
 176                 @Override
 177                 public Post setKnown(boolean known) {
 178                         return this;
 179                 }
 180
 181         }
 182
 183 }