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.database.AlbumBuilder;
32 import net.pterodactylus.sone.database.PostBuilder;
33 import net.pterodactylus.sone.database.PostBuilderFactory;
34 import net.pterodactylus.sone.database.PostReplyBuilder;
35 import net.pterodactylus.sone.freenet.wot.Identity;
36 import net.pterodactylus.sone.freenet.wot.OwnIdentity;
37 import net.pterodactylus.sone.template.SoneAccessor;
39 import freenet.keys.FreenetURI;
41 import com.google.common.base.Predicate;
42 import com.google.common.primitives.Ints;
45 * A Sone defines everything about a user: her profile, her status updates, her
46 * replies, her likes and dislikes, etc.
48 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
50 public interface Sone extends Identified, Fingerprintable, PostBuilderFactory, Comparable<Sone> {
53 * Enumeration for the possible states of a {@link Sone}.
55 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
57 public enum SoneStatus {
59 /** The Sone is unknown, i.e. not yet downloaded. */
62 /** The Sone is idle, i.e. not being downloaded or inserted. */
65 /** The Sone is currently being inserted. */
68 /** The Sone is currently being downloaded. */
73 * The possible values for the “show custom avatars” option.
75 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
77 public static enum ShowCustomAvatars {
79 /** Never show custom avatars. */
82 /** Only show custom avatars of followed Sones. */
85 /** Only show custom avatars of Sones you manually trust. */
88 /** Only show custom avatars of automatically trusted Sones. */
91 /** Always show custom avatars. */
96 /** comparator that sorts Sones by their nice name. */
97 public static final Comparator<Sone> NICE_NAME_COMPARATOR = new Comparator<Sone>() {
100 public int compare(Sone leftSone, Sone rightSone) {
101 int diff = SoneAccessor.getNiceName(leftSone).compareToIgnoreCase(SoneAccessor.getNiceName(rightSone));
105 return leftSone.getId().compareToIgnoreCase(rightSone.getId());
110 /** Comparator that sorts Sones by last activity (least recent active first). */
111 public static final Comparator<Sone> LAST_ACTIVITY_COMPARATOR = new Comparator<Sone>() {
114 public int compare(Sone firstSone, Sone secondSone) {
115 return (int) Math.min(Integer.MAX_VALUE, Math.max(Integer.MIN_VALUE, secondSone.getTime() - firstSone.getTime()));
119 /** Comparator that sorts Sones by numbers of posts (descending). */
120 public static final Comparator<Sone> POST_COUNT_COMPARATOR = new Comparator<Sone>() {
126 public int compare(Sone leftSone, Sone rightSone) {
127 return (leftSone.getPosts().size() != rightSone.getPosts().size()) ? (rightSone.getPosts().size() - leftSone.getPosts().size()) : (rightSone.getReplies().size() - leftSone.getReplies().size());
131 /** Comparator that sorts Sones by number of images (descending). */
132 public static final Comparator<Sone> IMAGE_COUNT_COMPARATOR = new Comparator<Sone>() {
138 public int compare(Sone leftSone, Sone rightSone) {
139 int rightSoneImageCount = from(asList(rightSone.getRootAlbum())).transformAndConcat(FLATTENER).transformAndConcat(IMAGES).size();
140 int leftSoneImageCount = from(asList(leftSone.getRootAlbum())).transformAndConcat(FLATTENER).transformAndConcat(IMAGES).size();
141 /* sort descending. */
142 return Ints.compare(rightSoneImageCount, leftSoneImageCount);
146 /** Filter to remove Sones that have not been downloaded. */
147 public static final Predicate<Sone> EMPTY_SONE_FILTER = new Predicate<Sone>() {
150 public boolean apply(Sone sone) {
151 return (sone == null) ? false : sone.getTime() != 0;
155 /** Filter that matches all {@link Sone#isLocal() local Sones}. */
156 public static final Predicate<Sone> LOCAL_SONE_FILTER = new Predicate<Sone>() {
159 public boolean apply(Sone sone) {
160 return (sone == null) ? false : sone.getIdentity() instanceof OwnIdentity;
165 /** Filter that matches Sones that have at least one album. */
166 public static final Predicate<Sone> HAS_ALBUM_FILTER = new Predicate<Sone>() {
169 public boolean apply(Sone sone) {
170 return (sone == null) ? false : !sone.getRootAlbum().getAlbums().isEmpty();
175 * Returns the identity of this Sone.
177 * @return The identity of this Sone
179 Identity getIdentity();
182 * Sets the identity of this Sone. The {@link Identity#getId() ID} of the
183 * identity has to match this Sone’s {@link #getId()}.
186 * The identity of this Sone
187 * @return This Sone (for method chaining)
188 * @throws IllegalArgumentException
189 * if the ID of the identity does not match this Sone’s ID
191 Sone setIdentity(Identity identity) throws IllegalArgumentException;
194 * Returns the name of this Sone.
196 * @return The name of this Sone
201 * Returns whether this Sone is a local Sone.
203 * @return {@code true} if this Sone is a local Sone, {@code false} otherwise
208 * Returns the request URI of this Sone.
210 * @return The request URI of this Sone
212 FreenetURI getRequestUri();
215 * Sets the request URI of this Sone.
218 * The request URI of this Sone
219 * @return This Sone (for method chaining)
221 Sone setRequestUri(FreenetURI requestUri);
224 * Returns the insert URI of this Sone.
226 * @return The insert URI of this Sone
228 FreenetURI getInsertUri();
231 * Sets the insert URI of this Sone.
234 * The insert URI of this Sone
235 * @return This Sone (for method chaining)
237 Sone setInsertUri(FreenetURI insertUri);
240 * Returns the latest edition of this Sone.
242 * @return The latest edition of this Sone
244 long getLatestEdition();
247 * Sets the latest edition of this Sone. If the given latest edition is not
248 * greater than the current latest edition, the latest edition of this Sone is
251 * @param latestEdition
252 * The latest edition of this Sone
254 void setLatestEdition(long latestEdition);
257 * Return the time of the last inserted update of this Sone.
259 * @return The time of the update (in milliseconds since Jan 1, 1970 UTC)
264 * Sets the time of the last inserted update of this Sone.
267 * The time of the update (in milliseconds since Jan 1, 1970 UTC)
268 * @return This Sone (for method chaining)
270 Sone setTime(long time);
273 * Returns the status of this Sone.
275 * @return The status of this Sone
277 SoneStatus getStatus();
280 * Sets the new status of this Sone.
283 * The new status of this Sone
285 * @throws IllegalArgumentException
286 * if {@code status} is {@code null}
288 Sone setStatus(SoneStatus status);
291 * Returns a copy of the profile. If you want to update values in the profile
292 * of this Sone, update the values in the returned {@link Profile} and use
293 * {@link #setProfile(Profile)} to change the profile in this Sone.
295 * @return A copy of the profile
297 Profile getProfile();
300 * Sets the profile of this Sone. A copy of the given profile is stored so that
301 * subsequent modifications of the given profile are not reflected in this
307 void setProfile(Profile profile);
310 * Returns the client used by this Sone.
312 * @return The client used by this Sone, or {@code null}
317 * Sets the client used by this Sone.
320 * The client used by this Sone, or {@code null}
321 * @return This Sone (for method chaining)
323 Sone setClient(Client client);
326 * Returns whether this Sone is known.
328 * @return {@code true} if this Sone is known, {@code false} otherwise
333 * Sets whether this Sone is known.
336 * {@code true} if this Sone is known, {@code false} otherwise
339 Sone setKnown(boolean known);
342 * Returns all friend Sones of this Sone.
344 * @return The friend Sones of this Sone
346 List<String> getFriends();
349 * Returns whether this Sone has the given Sone as a friend Sone.
351 * @param friendSoneId
352 * The ID of the Sone to check for
353 * @return {@code true} if this Sone has the given Sone as a friend, {@code
356 boolean hasFriend(String friendSoneId);
359 * Adds the given Sone as a friend Sone.
362 * The friend Sone to add
363 * @return This Sone (for method chaining)
365 Sone addFriend(String friendSone);
368 * Removes the given Sone as a friend Sone.
370 * @param friendSoneId
371 * The ID of the friend Sone to remove
372 * @return This Sone (for method chaining)
374 Sone removeFriend(String friendSoneId);
377 * Returns the list of posts of this Sone, sorted by time, newest first.
379 * @return All posts of this Sone
381 List<Post> getPosts();
384 * Sets all posts of this Sone at once.
387 * The new (and only) posts of this Sone
388 * @return This Sone (for method chaining)
390 Sone setPosts(Collection<Post> posts);
393 * Adds the given post to this Sone. The post will not be added if its {@link
394 * Post#getSone() Sone} is not this Sone.
399 void addPost(Post post);
402 * Removes the given post from this Sone.
407 void removePost(Post post);
410 * Returns all replies this Sone made.
412 * @return All replies this Sone made
414 Set<PostReply> getReplies();
417 * Sets all replies of this Sone at once.
420 * The new (and only) replies of this Sone
421 * @return This Sone (for method chaining)
423 Sone setReplies(Collection<PostReply> replies);
426 * Adds a reply to this Sone. If the given reply was not made by this Sone,
427 * nothing is added to this Sone.
432 void addReply(PostReply reply);
435 * Removes a reply from this Sone.
438 * The reply to remove
440 void removeReply(PostReply reply);
443 * Returns the IDs of all liked posts.
445 * @return All liked posts’ IDs
447 Set<String> getLikedPostIds();
450 * Sets the IDs of all liked posts.
452 * @param likedPostIds
453 * All liked posts’ IDs
454 * @return This Sone (for method chaining)
456 Sone setLikePostIds(Set<String> likedPostIds);
459 * Checks whether the given post ID is liked by this Sone.
463 * @return {@code true} if this Sone likes the given post, {@code false}
466 boolean isLikedPostId(String postId);
469 * Adds the given post ID to the list of posts this Sone likes.
473 * @return This Sone (for method chaining)
475 Sone addLikedPostId(String postId);
478 * Removes the given post ID from the list of posts this Sone likes.
482 * @return This Sone (for method chaining)
484 Sone removeLikedPostId(String postId);
487 * Returns the IDs of all liked replies.
489 * @return All liked replies’ IDs
491 Set<String> getLikedReplyIds();
494 * Sets the IDs of all liked replies.
496 * @param likedReplyIds
497 * All liked replies’ IDs
498 * @return This Sone (for method chaining)
500 Sone setLikeReplyIds(Set<String> likedReplyIds);
503 * Checks whether the given reply ID is liked by this Sone.
506 * The ID of the reply
507 * @return {@code true} if this Sone likes the given reply, {@code false}
510 boolean isLikedReplyId(String replyId);
513 * Adds the given reply ID to the list of replies this Sone likes.
516 * The ID of the reply
517 * @return This Sone (for method chaining)
519 Sone addLikedReplyId(String replyId);
522 * Removes the given post ID from the list of replies this Sone likes.
525 * The ID of the reply
526 * @return This Sone (for method chaining)
528 Sone removeLikedReplyId(String replyId);
531 * Returns the root album that contains all visible albums of this Sone.
533 * @return The root album of this Sone
535 Album getRootAlbum();
538 * Returns Sone-specific options.
540 * @return The options of this Sone
542 Options getOptions();
545 * Sets the options of this Sone.
548 * The options of this Sone
550 /* TODO - remove this method again, maybe add an option provider */
551 void setOptions(Options options);
553 AlbumBuilder newAlbumBuilder() throws IllegalStateException;
555 PostBuilder newPostBuilder();
557 PostReplyBuilder newPostReplyBuilder(String postId) throws IllegalStateException;