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

   1 /*
   2  * Sone - Post.java - Copyright © 2010–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 java.util.Comparator;
  21 import java.util.List;
  22
  23 import com.google.common.base.Optional;
  24 import com.google.common.base.Predicate;
  25
  26 /**
  27  * A post is a short message that a user writes in his Sone to let other users
  28  * know what is going on.
  29  *
  30  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  31  */
  32 public interface Post extends Identified {
  33
  34         /** Comparator for posts, sorts descending by time. */
  35         public static final Comparator<Post> TIME_COMPARATOR = new Comparator<Post>() {
  36
  37                 @Override
  38                 public int compare(Post leftPost, Post rightPost) {
  39                         return (int) Math.max(Integer.MIN_VALUE, Math.min(Integer.MAX_VALUE, rightPost.getTime() - leftPost.getTime()));
  40                 }
  41
  42         };
  43
  44         /** Filter for posts with timestamps from the future. */
  45         public static final Predicate<Post> FUTURE_POSTS_FILTER = new Predicate<Post>() {
  46
  47                 @Override
  48                 public boolean apply(Post post) {
  49                         return (post == null) ? false : post.getTime() <= System.currentTimeMillis();
  50                 }
  51
  52         };
  53
  54         //
  55         // ACCESSORS
  56         //
  57
  58         /**
  59          * Returns the ID of the post.
  60          *
  61          * @return The ID of the post
  62          */
  63         public String getId();
  64
  65         /**
  66          * Returns the Sone this post belongs to.
  67          *
  68          * @return The Sone of this post
  69          */
  70         public Sone getSone();
  71
  72         /**
  73          * Returns the ID of the recipient {@link Sone}, or
  74          * {@link Optional#absent()} if this post does not have a recipient.
  75          *
  76          * @return The ID of the recipient, or {@link Optional#absent()}
  77          */
  78         public Optional<String> getRecipientId();
  79
  80         /**
  81          * Returns the recipient of this post, if any.
  82          *
  83          * @return The recipient of this post, or {@link Optional#absent()} if there
  84          *         is no recipient
  85          */
  86         public Optional<Sone> getRecipient();
  87
  88         /**
  89          * Returns the time of the post.
  90          *
  91          * @return The time of the post (in milliseconds since Jan 1, 1970 UTC)
  92          */
  93         public long getTime();
  94
  95         /**
  96          * Returns the text of the post.
  97          *
  98          * @return The text of the post
  99          */
 100         public String getText();
 101
 102         /**
 103          * Returns whether this post is known.
 104          *
 105          * @return {@code true} if this post is known, {@code false} otherwise
 106          */
 107         public boolean isKnown();
 108
 109         /**
 110          * Sets whether this post is known.
 111          *
 112          * @param known
 113          *            {@code true} if this post is known, {@code false} otherwise
 114          * @return This post
 115          */
 116         public Post setKnown(boolean known);
 117
 118         List<PostReply> getReplies();
 119
 120 }