/*
- * Sone - Post.java - Copyright © 2010–2013 David Roden
+ * Sone - Post.java - Copyright © 2010–2016 David Roden
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
package net.pterodactylus.sone.data;
+import static com.google.common.base.Optional.absent;
+
import java.util.Comparator;
+import com.google.common.base.Optional;
import com.google.common.base.Predicate;
/**
* A post is a short message that a user writes in his Sone to let other users
* know what is going on.
- *
- * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
*/
-public interface Post {
+public interface Post extends Identified {
/** Comparator for posts, sorts descending by time. */
- public static final Comparator<Post> TIME_COMPARATOR = new Comparator<Post>() {
+ public static final Comparator<Post> NEWEST_FIRST = new Comparator<Post>() {
@Override
public int compare(Post leftPost, Post rightPost) {
@Override
public boolean apply(Post post) {
- return post.getTime() <= System.currentTimeMillis();
+ return (post != null) && (post.getTime() <= System.currentTimeMillis());
}
};
public String getId();
/**
- * Returns the Sone this post belongs to.
+ * Returns whether this post has already been loaded.
*
- * @return The Sone of this post
+ * @return {@code true} if this post has already been loaded, {@code
+ * false} otherwise
*/
- public Sone getSone();
+ boolean isLoaded();
/**
- * Sets the Sone of this post.
+ * Returns the Sone this post belongs to.
*
- * @param sone
- * The Sone of this post
- * @return This post (for method chaining)
+ * @return The Sone of this post
*/
- public Post setSone(Sone sone);
+ public Sone getSone();
/**
- * Returns the recipient of this post, if any.
+ * Returns the ID of the recipient {@link Sone}, or
+ * {@link Optional#absent()} if this post does not have a recipient.
*
- * @return The recipient of this post, or {@code null}
+ * @return The ID of the recipient, or {@link Optional#absent()}
*/
- public Sone getRecipient();
+ public Optional<String> getRecipientId();
/**
- * Sets the recipient of this post.
+ * Returns the recipient of this post, if any.
*
- * @param recipient
- * The recipient of this post, or {@code null}
- * @return This post (for method chaining)
+ * @return The recipient of this post, or {@link Optional#absent()} if there
+ * is no recipient
*/
- public Post setRecipient(Sone recipient);
+ public Optional<Sone> getRecipient();
/**
* Returns the time of the post.
public long getTime();
/**
- * Sets the time of this post.
- *
- * @param time
- * The time of this post (in milliseconds since Jan 1, 1970 UTC)
- * @return This post (for method chaining)
- */
- public Post setTime(long time);
-
- /**
* Returns the text of the post.
*
* @return The text of the post
public String getText();
/**
- * Sets the text of this post.
- *
- * @param text
- * The text of this post
- * @return This post (for method chaining)
- */
- public Post setText(String text);
-
- /**
* Returns whether this post is known.
*
* @return {@code true} if this post is known, {@code false} otherwise
*/
public Post setKnown(boolean known);
+ /**
+ * Shell for a post that has not yet been loaded.
+ */
+ public static class EmptyPost implements Post {
+
+ private final String id;
+
+ public EmptyPost(String id) {
+ this.id = id;
+ }
+
+ @Override
+ public String getId() {
+ return id;
+ }
+
+ @Override
+ public boolean isLoaded() {
+ return false;
+ }
+
+ @Override
+ public Sone getSone() {
+ return null;
+ }
+
+ @Override
+ public Optional<String> getRecipientId() {
+ return absent();
+ }
+
+ @Override
+ public Optional<Sone> getRecipient() {
+ return absent();
+ }
+
+ @Override
+ public long getTime() {
+ return 0;
+ }
+
+ @Override
+ public String getText() {
+ return null;
+ }
+
+ @Override
+ public boolean isKnown() {
+ return false;
+ }
+
+ @Override
+ public Post setKnown(boolean known) {
+ return this;
+ }
+
+ }
+
}