/*
- * FreenetSone - StatusUpdate.java - Copyright © 2010 David Roden
+ * Sone - Post.java - Copyright © 2010–2019 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 java.util.Collection;
-import java.util.Collections;
-import java.util.HashSet;
-import java.util.Set;
-import java.util.UUID;
+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 class Post {
+public interface Post extends Identified {
+
+ /** Comparator for posts, sorts descending by time. */
+ public static final Comparator<Post> NEWEST_FIRST = new Comparator<Post>() {
- /** The GUID of the post. */
- private final UUID id;
+ @Override
+ public int compare(Post leftPost, Post rightPost) {
+ return (int) Math.max(Integer.MIN_VALUE, Math.min(Integer.MAX_VALUE, rightPost.getTime() - leftPost.getTime()));
+ }
- /** The Sone this post belongs to. */
- private final Sone sone;
+ };
- /** The time of the post (in milliseconds since Jan 1, 1970 UTC). */
- private final long time;
+ /** Filter for posts with timestamps from the future. */
+ public static final Predicate<Post> FUTURE_POSTS_FILTER = new Predicate<Post>() {
- /** The text of the post. */
- private final String text;
+ @Override
+ public boolean apply(Post post) {
+ return (post != null) && (post.getTime() <= System.currentTimeMillis());
+ }
- /** The replies that have been loaded for this post. */
- private final Set<Reply> replies = new HashSet<Reply>();
+ };
+
+ //
+ // ACCESSORS
+ //
/**
- * Creates a new post.
+ * Returns the ID of the post.
*
- * @param sone
- * The Sone this post belongs to
- * @param text
- * The text of the post
+ * @return The ID of the post
*/
- public Post(Sone sone, String text) {
- this(sone, System.currentTimeMillis(), text);
- }
+ public String getId();
/**
- * Creates a new post.
+ * Returns whether this post has already been loaded.
*
- * @param sone
- * The Sone this post belongs to
- * @param time
- * The time of the post (in milliseconds since Jan 1, 1970 UTC)
- * @param text
- * The text of the post
+ * @return {@code true} if this post has already been loaded, {@code
+ * false} otherwise
*/
- public Post(Sone sone, long time, String text) {
- this(UUID.randomUUID(), sone, time, text);
- }
+ boolean isLoaded();
/**
- * Creates a new post.
+ * Returns the Sone this post belongs to.
*
- * @param id
- * The ID of the post
- * @param sone
- * The Sone this post belongs to
- * @param time
- * The time of the post (in milliseconds since Jan 1, 1970 UTC)
- * @param text
- * The text of the post
+ * @return The Sone of this post
*/
- public Post(UUID id, Sone sone, long time, String text) {
- this.id = id;
- this.sone = sone;
- this.time = time;
- this.text = text;
- }
-
- //
- // ACCESSORS
- //
+ public Sone getSone();
/**
- * Returns the ID of the post.
+ * Returns the ID of the recipient {@link Sone}, or
+ * {@link Optional#absent()} if this post does not have a recipient.
*
- * @return The ID of the post
+ * @return The ID of the recipient, or {@link Optional#absent()}
*/
- public String getId() {
- return id.toString();
- }
+ public Optional<String> getRecipientId();
/**
- * Returns the Sone this post belongs to.
+ * Returns the recipient of this post, if any.
*
- * @return The Sone of this post
+ * @return The recipient of this post, or {@link Optional#absent()} if there
+ * is no recipient
*/
- public Sone getSone() {
- return sone;
- }
+ public Optional<Sone> getRecipient();
/**
* Returns the time of the post.
*
* @return The time of the post (in milliseconds since Jan 1, 1970 UTC)
*/
- public long getTime() {
- return time;
- }
+ public long getTime();
/**
* Returns the text of the post.
*
* @return The text of the post
*/
- public String getText() {
- return text;
- }
+ public String getText();
/**
- * Returns all replies to this post in unspecified order.
+ * Returns whether this post is known.
*
- * @return All replies to this post
+ * @return {@code true} if this post is known, {@code false} otherwise
*/
- public Collection<Reply> getReplies() {
- return Collections.unmodifiableSet(replies);
- }
+ public boolean isKnown();
/**
- * Adds a reply to this post. The reply will not be added if its
- * {@link Reply#getPost() post} is not equal to this post.
+ * Sets whether this post is known.
*
- * @param reply
- * The reply to add
+ * @param known
+ * {@code true} if this post is known, {@code false} otherwise
+ * @return This post
*/
- public void addReply(Reply reply) {
- if (reply.getPost().equals(this)) {
- replies.add(reply);
- }
- }
+ public Post setKnown(boolean known);
/**
- * Removes a reply from this post.
- *
- * @param reply
- * The reply to remove
+ * Shell for a post that has not yet been loaded.
*/
- public void removeReply(Reply reply) {
- if (reply.getPost().equals(this)) {
- replies.remove(reply);
+ public static class EmptyPost implements Post {
+
+ private final String id;
+
+ public EmptyPost(String id) {
+ this.id = id;
}
- }
- //
- // OBJECT METHODS
- //
+ @Override
+ public String getId() {
+ return id;
+ }
- /**
- * {@inheritDoc}
- */
- @Override
- public int hashCode() {
- return id.hashCode();
- }
+ @Override
+ public boolean isLoaded() {
+ return false;
+ }
- /**
- * {@inheritDoc}
- */
- @Override
- public boolean equals(Object object) {
- if (!(object instanceof Post)) {
+ @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;
}
- return ((Post) object).id.equals(id);
+
+ @Override
+ public Post setKnown(boolean known) {
+ return this;
+ }
+
}
}
projects / Sone.git / blobdiff