2 * Sone - Sone.java - Copyright © 2010–2013 David Roden
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.
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.
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/>.
18 package net.pterodactylus.sone.data;
20 import static com.google.common.collect.FluentIterable.from;
21 import static java.util.Arrays.asList;
22 import static net.pterodactylus.sone.data.Album.FLATTENER;
23 import static net.pterodactylus.sone.data.Album.IMAGES;
25 import java.util.Collection;
26 import java.util.Comparator;
27 import java.util.List;
30 import net.pterodactylus.sone.core.Options;
31 import net.pterodactylus.sone.freenet.wot.Identity;
32 import net.pterodactylus.sone.freenet.wot.OwnIdentity;
33 import net.pterodactylus.sone.template.SoneAccessor;
35 import freenet.keys.FreenetURI;
37 import com.google.common.base.Predicate;
38 import com.google.common.primitives.Ints;
41 * A Sone defines everything about a user: her profile, her status updates, her
42 * replies, her likes and dislikes, etc.
44 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
46 public interface Sone extends Identified, Fingerprintable, Comparable<Sone> {
49 * Enumeration for the possible states of a {@link Sone}.
51 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
53 public enum SoneStatus {
55 /** The Sone is unknown, i.e. not yet downloaded. */
58 /** The Sone is idle, i.e. not being downloaded or inserted. */
61 /** The Sone is currently being inserted. */
64 /** The Sone is currently being downloaded. */
69 * The possible values for the “show custom avatars” option.
71 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
73 public static enum ShowCustomAvatars {
75 /** Never show custom avatars. */
78 /** Only show custom avatars of followed Sones. */
81 /** Only show custom avatars of Sones you manually trust. */
84 /** Only show custom avatars of automatically trusted Sones. */
87 /** Always show custom avatars. */
92 /** comparator that sorts Sones by their nice name. */
93 public static final Comparator<Sone> NICE_NAME_COMPARATOR = new Comparator<Sone>() {
96 public int compare(Sone leftSone, Sone rightSone) {
97 int diff = SoneAccessor.getNiceName(leftSone).compareToIgnoreCase(SoneAccessor.getNiceName(rightSone));
101 return leftSone.getId().compareToIgnoreCase(rightSone.getId());
106 /** Comparator that sorts Sones by last activity (least recent active first). */
107 public static final Comparator<Sone> LAST_ACTIVITY_COMPARATOR = new Comparator<Sone>() {
110 public int compare(Sone firstSone, Sone secondSone) {
111 return (int) Math.min(Integer.MAX_VALUE, Math.max(Integer.MIN_VALUE, secondSone.getTime() - firstSone.getTime()));
115 /** Comparator that sorts Sones by numbers of posts (descending). */
116 public static final Comparator<Sone> POST_COUNT_COMPARATOR = new Comparator<Sone>() {
122 public int compare(Sone leftSone, Sone rightSone) {
123 return (leftSone.getPosts().size() != rightSone.getPosts().size()) ? (rightSone.getPosts().size() - leftSone.getPosts().size()) : (rightSone.getReplies().size() - leftSone.getReplies().size());
127 /** Comparator that sorts Sones by number of images (descending). */
128 public static final Comparator<Sone> IMAGE_COUNT_COMPARATOR = new Comparator<Sone>() {
134 public int compare(Sone leftSone, Sone rightSone) {
135 int rightSoneImageCount = from(asList(rightSone.getRootAlbum())).transformAndConcat(FLATTENER).transformAndConcat(IMAGES).size();
136 int leftSoneImageCount = from(asList(leftSone.getRootAlbum())).transformAndConcat(FLATTENER).transformAndConcat(IMAGES).size();
137 /* sort descending. */
138 return Ints.compare(rightSoneImageCount, leftSoneImageCount);
142 /** Filter to remove Sones that have not been downloaded. */
143 public static final Predicate<Sone> EMPTY_SONE_FILTER = new Predicate<Sone>() {
146 public boolean apply(Sone sone) {
147 return (sone != null) && (sone.getTime() != 0);
151 /** Filter that matches all {@link Sone#isLocal() local Sones}. */
152 public static final Predicate<Sone> LOCAL_SONE_FILTER = new Predicate<Sone>() {
155 public boolean apply(Sone sone) {
156 return (sone != null) && (sone.getIdentity() instanceof OwnIdentity);
161 /** Filter that matches Sones that have at least one album. */
162 public static final Predicate<Sone> HAS_ALBUM_FILTER = new Predicate<Sone>() {
165 public boolean apply(Sone sone) {
166 return (sone != null) && !sone.getRootAlbum().getAlbums().isEmpty();
171 * Returns the identity of this Sone.
173 * @return The identity of this Sone
175 Identity getIdentity();
178 * Sets the identity of this Sone. The {@link Identity#getId() ID} of the
179 * identity has to match this Sone’s {@link #getId()}.
182 * The identity of this Sone
183 * @return This Sone (for method chaining)
184 * @throws IllegalArgumentException
185 * if the ID of the identity does not match this Sone’s ID
187 Sone setIdentity(Identity identity) throws IllegalArgumentException;
190 * Returns the name of this Sone.
192 * @return The name of this Sone
197 * Returns whether this Sone is a local Sone.
199 * @return {@code true} if this Sone is a local Sone, {@code false} otherwise
204 * Returns the request URI of this Sone.
206 * @return The request URI of this Sone
208 FreenetURI getRequestUri();
211 * Sets the request URI of this Sone.
214 * The request URI of this Sone
215 * @return This Sone (for method chaining)
217 Sone setRequestUri(FreenetURI requestUri);
220 * Returns the insert URI of this Sone.
222 * @return The insert URI of this Sone
224 FreenetURI getInsertUri();
227 * Sets the insert URI of this Sone.
230 * The insert URI of this Sone
231 * @return This Sone (for method chaining)
233 Sone setInsertUri(FreenetURI insertUri);
236 * Returns the latest edition of this Sone.
238 * @return The latest edition of this Sone
240 long getLatestEdition();
243 * Sets the latest edition of this Sone. If the given latest edition is not
244 * greater than the current latest edition, the latest edition of this Sone is
247 * @param latestEdition
248 * The latest edition of this Sone
250 void setLatestEdition(long latestEdition);
253 * Return the time of the last inserted update of this Sone.
255 * @return The time of the update (in milliseconds since Jan 1, 1970 UTC)
260 * Sets the time of the last inserted update of this Sone.
263 * The time of the update (in milliseconds since Jan 1, 1970 UTC)
264 * @return This Sone (for method chaining)
266 Sone setTime(long time);
269 * Returns the status of this Sone.
271 * @return The status of this Sone
273 SoneStatus getStatus();
276 * Sets the new status of this Sone.
279 * The new status of this Sone
281 * @throws IllegalArgumentException
282 * if {@code status} is {@code null}
284 Sone setStatus(SoneStatus status);
287 * Returns a copy of the profile. If you want to update values in the profile
288 * of this Sone, update the values in the returned {@link Profile} and use
289 * {@link #setProfile(Profile)} to change the profile in this Sone.
291 * @return A copy of the profile
293 Profile getProfile();
296 * Sets the profile of this Sone. A copy of the given profile is stored so that
297 * subsequent modifications of the given profile are not reflected in this
303 void setProfile(Profile profile);
306 * Returns the client used by this Sone.
308 * @return The client used by this Sone, or {@code null}
313 * Sets the client used by this Sone.
316 * The client used by this Sone, or {@code null}
317 * @return This Sone (for method chaining)
319 Sone setClient(Client client);
322 * Returns whether this Sone is known.
324 * @return {@code true} if this Sone is known, {@code false} otherwise
329 * Sets whether this Sone is known.
332 * {@code true} if this Sone is known, {@code false} otherwise
335 Sone setKnown(boolean known);
338 * Returns all friend Sones of this Sone.
340 * @return The friend Sones of this Sone
342 List<String> getFriends();
345 * Returns whether this Sone has the given Sone as a friend Sone.
347 * @param friendSoneId
348 * The ID of the Sone to check for
349 * @return {@code true} if this Sone has the given Sone as a friend, {@code
352 boolean hasFriend(String friendSoneId);
355 * Adds the given Sone as a friend Sone.
358 * The friend Sone to add
359 * @return This Sone (for method chaining)
361 Sone addFriend(String friendSone);
364 * Removes the given Sone as a friend Sone.
366 * @param friendSoneId
367 * The ID of the friend Sone to remove
368 * @return This Sone (for method chaining)
370 Sone removeFriend(String friendSoneId);
373 * Returns the list of posts of this Sone, sorted by time, newest first.
375 * @return All posts of this Sone
377 List<Post> getPosts();
380 * Sets all posts of this Sone at once.
383 * The new (and only) posts of this Sone
384 * @return This Sone (for method chaining)
386 Sone setPosts(Collection<Post> posts);
389 * Adds the given post to this Sone. The post will not be added if its {@link
390 * Post#getSone() Sone} is not this Sone.
395 void addPost(Post post);
398 * Removes the given post from this Sone.
403 void removePost(Post post);
406 * Returns all replies this Sone made.
408 * @return All replies this Sone made
410 Set<PostReply> getReplies();
413 * Sets all replies of this Sone at once.
416 * The new (and only) replies of this Sone
417 * @return This Sone (for method chaining)
419 Sone setReplies(Collection<PostReply> replies);
422 * Adds a reply to this Sone. If the given reply was not made by this Sone,
423 * nothing is added to this Sone.
428 void addReply(PostReply reply);
431 * Removes a reply from this Sone.
434 * The reply to remove
436 void removeReply(PostReply reply);
439 * Returns the IDs of all liked posts.
441 * @return All liked posts’ IDs
443 Set<String> getLikedPostIds();
446 * Sets the IDs of all liked posts.
448 * @param likedPostIds
449 * All liked posts’ IDs
450 * @return This Sone (for method chaining)
452 Sone setLikePostIds(Set<String> likedPostIds);
455 * Checks whether the given post ID is liked by this Sone.
459 * @return {@code true} if this Sone likes the given post, {@code false}
462 boolean isLikedPostId(String postId);
465 * Adds the given post ID to the list of posts this Sone likes.
469 * @return This Sone (for method chaining)
471 Sone addLikedPostId(String postId);
474 * Removes the given post ID from the list of posts this Sone likes.
478 * @return This Sone (for method chaining)
480 Sone removeLikedPostId(String postId);
483 * Returns the IDs of all liked replies.
485 * @return All liked replies’ IDs
487 Set<String> getLikedReplyIds();
490 * Sets the IDs of all liked replies.
492 * @param likedReplyIds
493 * All liked replies’ IDs
494 * @return This Sone (for method chaining)
496 Sone setLikeReplyIds(Set<String> likedReplyIds);
499 * Checks whether the given reply ID is liked by this Sone.
502 * The ID of the reply
503 * @return {@code true} if this Sone likes the given reply, {@code false}
506 boolean isLikedReplyId(String replyId);
509 * Adds the given reply ID to the list of replies this Sone likes.
512 * The ID of the reply
513 * @return This Sone (for method chaining)
515 Sone addLikedReplyId(String replyId);
518 * Removes the given post ID from the list of replies this Sone likes.
521 * The ID of the reply
522 * @return This Sone (for method chaining)
524 Sone removeLikedReplyId(String replyId);
527 * Returns the root album that contains all visible albums of this Sone.
529 * @return The root album of this Sone
531 Album getRootAlbum();
534 * Returns Sone-specific options.
536 * @return The options of this Sone
538 SoneOptions getOptions();
541 * Sets the options of this Sone.
544 * The options of this Sone
546 /* TODO - remove this method again, maybe add an option provider */
547 void setOptions(SoneOptions options);