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 javax.annotation.Nonnegative;
31 import javax.annotation.Nonnull;
32 import javax.annotation.Nullable;
34 import net.pterodactylus.sone.freenet.wot.Identity;
35 import net.pterodactylus.sone.freenet.wot.OwnIdentity;
36 import net.pterodactylus.sone.template.SoneAccessor;
38 import freenet.keys.FreenetURI;
40 import com.google.common.base.Function;
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, 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) && (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) && (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) && !sone.getRootAlbum().getAlbums().isEmpty();
174 public static final Function<Sone, String> toSoneXmlUri =
175 new Function<Sone, String>() {
178 public String apply(@Nullable Sone input) {
179 return input.getRequestUri()
180 .setMetaString(new String[] { "sone.xml" })
186 * Returns the identity of this Sone.
188 * @return The identity of this Sone
190 Identity getIdentity();
193 * Sets the identity of this Sone. The {@link Identity#getId() ID} of the
194 * identity has to match this Sone’s {@link #getId()}.
197 * The identity of this Sone
198 * @return This Sone (for method chaining)
199 * @throws IllegalArgumentException
200 * if the ID of the identity does not match this Sone’s ID
202 Sone setIdentity(Identity identity) throws IllegalArgumentException;
205 * Returns the name of this Sone.
207 * @return The name of this Sone
212 * Returns whether this Sone is a local Sone.
214 * @return {@code true} if this Sone is a local Sone, {@code false} otherwise
219 * Returns the request URI of this Sone.
221 * @return The request URI of this Sone
223 FreenetURI getRequestUri();
226 * Sets the request URI of this Sone.
229 * The request URI of this Sone
230 * @return This Sone (for method chaining)
232 Sone setRequestUri(FreenetURI requestUri);
235 * Returns the insert URI of this Sone.
237 * @return The insert URI of this Sone
239 FreenetURI getInsertUri();
242 * Sets the insert URI of this Sone.
245 * The insert URI of this Sone
246 * @return This Sone (for method chaining)
248 Sone setInsertUri(FreenetURI insertUri);
251 * Returns the latest edition of this Sone.
253 * @return The latest edition of this Sone
255 long getLatestEdition();
258 * Sets the latest edition of this Sone. If the given latest edition is not
259 * greater than the current latest edition, the latest edition of this Sone is
262 * @param latestEdition
263 * The latest edition of this Sone
265 void setLatestEdition(long latestEdition);
268 * Return the time of the last inserted update of this Sone.
270 * @return The time of the update (in milliseconds since Jan 1, 1970 UTC)
275 * Sets the time of the last inserted update of this Sone.
278 * The time of the update (in milliseconds since Jan 1, 1970 UTC)
279 * @return This Sone (for method chaining)
281 Sone setTime(long time);
284 * Returns the status of this Sone.
286 * @return The status of this Sone
288 SoneStatus getStatus();
291 * Sets the new status of this Sone.
294 * The new status of this Sone
296 * @throws IllegalArgumentException
297 * if {@code status} is {@code null}
299 Sone setStatus(SoneStatus status);
302 * Returns a copy of the profile. If you want to update values in the profile
303 * of this Sone, update the values in the returned {@link Profile} and use
304 * {@link #setProfile(Profile)} to change the profile in this Sone.
306 * @return A copy of the profile
308 Profile getProfile();
311 * Sets the profile of this Sone. A copy of the given profile is stored so that
312 * subsequent modifications of the given profile are not reflected in this
318 void setProfile(Profile profile);
321 * Returns the client used by this Sone.
323 * @return The client used by this Sone, or {@code null}
328 * Sets the client used by this Sone.
331 * The client used by this Sone, or {@code null}
332 * @return This Sone (for method chaining)
334 Sone setClient(Client client);
337 * Returns whether this Sone is known.
339 * @return {@code true} if this Sone is known, {@code false} otherwise
344 * Sets whether this Sone is known.
347 * {@code true} if this Sone is known, {@code false} otherwise
350 Sone setKnown(boolean known);
353 * Returns all friend Sones of this Sone.
355 * @return The friend Sones of this Sone
357 List<String> getFriends();
360 * Returns whether this Sone has the given Sone as a friend Sone.
362 * @param friendSoneId
363 * The ID of the Sone to check for
364 * @return {@code true} if this Sone has the given Sone as a friend, {@code
367 boolean hasFriend(String friendSoneId);
370 * Adds the given Sone as a friend Sone.
373 * The friend Sone to add
374 * @return This Sone (for method chaining)
376 Sone addFriend(String friendSone);
379 * Removes the given Sone as a friend Sone.
381 * @param friendSoneId
382 * The ID of the friend Sone to remove
383 * @return This Sone (for method chaining)
385 Sone removeFriend(String friendSoneId);
388 * Returns the list of posts of this Sone, sorted by time, newest first.
390 * @return All posts of this Sone
392 List<Post> getPosts();
395 * Sets all posts of this Sone at once.
398 * The new (and only) posts of this Sone
399 * @return This Sone (for method chaining)
401 Sone setPosts(Collection<Post> posts);
404 * Adds the given post to this Sone. The post will not be added if its {@link
405 * Post#getSone() Sone} is not this Sone.
410 void addPost(Post post);
413 * Removes the given post from this Sone.
418 void removePost(Post post);
421 * Returns all replies this Sone made.
423 * @return All replies this Sone made
425 Set<PostReply> getReplies();
428 * Sets all replies of this Sone at once.
431 * The new (and only) replies of this Sone
432 * @return This Sone (for method chaining)
434 Sone setReplies(Collection<PostReply> replies);
437 * Adds a reply to this Sone. If the given reply was not made by this Sone,
438 * nothing is added to this Sone.
443 void addReply(PostReply reply);
446 * Removes a reply from this Sone.
449 * The reply to remove
451 void removeReply(PostReply reply);
454 * Returns the IDs of all liked posts.
456 * @return All liked posts’ IDs
458 Set<String> getLikedPostIds();
461 * Sets the IDs of all liked posts.
463 * @param likedPostIds
464 * All liked posts’ IDs
465 * @return This Sone (for method chaining)
467 Sone setLikePostIds(Set<String> likedPostIds);
470 * Checks whether the given post ID is liked by this Sone.
474 * @return {@code true} if this Sone likes the given post, {@code false}
477 boolean isLikedPostId(String postId);
480 * Adds the given post ID to the list of posts this Sone likes.
484 * @return This Sone (for method chaining)
486 Sone addLikedPostId(String postId);
489 * Removes the given post ID from the list of posts this Sone likes.
493 * @return This Sone (for method chaining)
495 Sone removeLikedPostId(String postId);
498 * Returns the IDs of all liked replies.
500 * @return All liked replies’ IDs
502 Set<String> getLikedReplyIds();
505 * Sets the IDs of all liked replies.
507 * @param likedReplyIds
508 * All liked replies’ IDs
509 * @return This Sone (for method chaining)
511 Sone setLikeReplyIds(Set<String> likedReplyIds);
514 * Checks whether the given reply ID is liked by this Sone.
517 * The ID of the reply
518 * @return {@code true} if this Sone likes the given reply, {@code false}
521 boolean isLikedReplyId(String replyId);
524 * Adds the given reply ID to the list of replies this Sone likes.
527 * The ID of the reply
528 * @return This Sone (for method chaining)
530 Sone addLikedReplyId(String replyId);
533 * Removes the given post ID from the list of replies this Sone likes.
536 * The ID of the reply
537 * @return This Sone (for method chaining)
539 Sone removeLikedReplyId(String replyId);
542 * Returns the root album that contains all visible albums of this Sone.
544 * @return The root album of this Sone
546 Album getRootAlbum();
549 * Returns Sone-specific options.
551 * @return The options of this Sone
553 SoneOptions getOptions();
556 * Sets the options of this Sone.
559 * The options of this Sone
561 /* TODO - remove this method again, maybe add an option provider */
562 void setOptions(SoneOptions options);