2 * Sone - Sone.java - Copyright Ā© 2010ā2015 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.Collections;
27 import java.util.Comparator;
28 import java.util.List;
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, List<Album>> toAllAlbums = new Function<Sone, List<Album>>() {
176 public List<Album> apply(@Nullable Sone sone) {
177 return (sone == null) ? Collections.<Album>emptyList() : FLATTENER.apply(
178 sone.getRootAlbum());
182 public static final Function<Sone, List<Image>> toAllImages = new Function<Sone, List<Image>>() {
184 public List<Image> apply(@Nullable Sone sone) {
185 return (sone == null) ? Collections.<Image>emptyList() :
186 from(FLATTENER.apply(sone.getRootAlbum()))
187 .transformAndConcat(IMAGES).toList();
192 * Returns the identity of this Sone.
194 * @return The identity of this Sone
196 Identity getIdentity();
199 * Returns the name of this Sone.
201 * @return The name of this Sone
206 * Returns whether this Sone is a local Sone.
208 * @return {@code true} if this Sone is a local Sone, {@code false} otherwise
213 * Returns the request URI of this Sone.
215 * @return The request URI of this Sone
217 FreenetURI getRequestUri();
220 * Returns the insert URI of this Sone.
222 * @return The insert URI of this Sone
224 FreenetURI getInsertUri();
227 * Returns the latest edition of this Sone.
229 * @return The latest edition of this Sone
231 long getLatestEdition();
234 * Sets the latest edition of this Sone. If the given latest edition is not
235 * greater than the current latest edition, the latest edition of this Sone is
238 * @param latestEdition
239 * The latest edition of this Sone
241 void setLatestEdition(long latestEdition);
244 * Return the time of the last inserted update of this Sone.
246 * @return The time of the update (in milliseconds since Jan 1, 1970 UTC)
251 * Sets the time of the last inserted update of this Sone.
254 * The time of the update (in milliseconds since Jan 1, 1970 UTC)
255 * @return This Sone (for method chaining)
257 Sone setTime(long time);
260 * Returns the status of this Sone.
262 * @return The status of this Sone
264 SoneStatus getStatus();
267 * Sets the new status of this Sone.
270 * The new status of this Sone
272 * @throws IllegalArgumentException
273 * if {@code status} is {@code null}
275 Sone setStatus(SoneStatus status);
278 * Returns a copy of the profile. If you want to update values in the profile
279 * of this Sone, update the values in the returned {@link Profile} and use
280 * {@link #setProfile(Profile)} to change the profile in this Sone.
282 * @return A copy of the profile
284 Profile getProfile();
287 * Sets the profile of this Sone. A copy of the given profile is stored so that
288 * subsequent modifications of the given profile are not reflected in this
294 void setProfile(Profile profile);
297 * Returns the client used by this Sone.
299 * @return The client used by this Sone, or {@code null}
304 * Sets the client used by this Sone.
307 * The client used by this Sone, or {@code null}
308 * @return This Sone (for method chaining)
310 Sone setClient(Client client);
313 * Returns whether this Sone is known.
315 * @return {@code true} if this Sone is known, {@code false} otherwise
320 * Sets whether this Sone is known.
323 * {@code true} if this Sone is known, {@code false} otherwise
326 Sone setKnown(boolean known);
329 * Returns all friend Sones of this Sone.
331 * @return The friend Sones of this Sone
333 Collection<String> getFriends();
336 * Returns whether this Sone has the given Sone as a friend Sone.
338 * @param friendSoneId
339 * The ID of the Sone to check for
340 * @return {@code true} if this Sone has the given Sone as a friend, {@code
343 boolean hasFriend(String friendSoneId);
346 * Returns the list of posts of this Sone, sorted by time, newest first.
348 * @return All posts of this Sone
350 List<Post> getPosts();
353 * Sets all posts of this Sone at once.
356 * The new (and only) posts of this Sone
357 * @return This Sone (for method chaining)
359 Sone setPosts(Collection<Post> posts);
362 * Adds the given post to this Sone. The post will not be added if its {@link
363 * Post#getSone() Sone} is not this Sone.
368 void addPost(Post post);
371 * Removes the given post from this Sone.
376 void removePost(Post post);
379 * Returns all replies this Sone made.
381 * @return All replies this Sone made
383 Set<PostReply> getReplies();
386 * Sets all replies of this Sone at once.
389 * The new (and only) replies of this Sone
390 * @return This Sone (for method chaining)
392 Sone setReplies(Collection<PostReply> replies);
395 * Adds a reply to this Sone. If the given reply was not made by this Sone,
396 * nothing is added to this Sone.
401 void addReply(PostReply reply);
404 * Removes a reply from this Sone.
407 * The reply to remove
409 void removeReply(PostReply reply);
412 * Returns the IDs of all liked posts.
414 * @return All liked postsā IDs
416 Set<String> getLikedPostIds();
419 * Sets the IDs of all liked posts.
421 * @param likedPostIds
422 * All liked postsā IDs
423 * @return This Sone (for method chaining)
425 Sone setLikePostIds(Set<String> likedPostIds);
428 * Checks whether the given post ID is liked by this Sone.
432 * @return {@code true} if this Sone likes the given post, {@code false}
435 boolean isLikedPostId(String postId);
438 * Adds the given post ID to the list of posts this Sone likes.
442 * @return This Sone (for method chaining)
444 Sone addLikedPostId(String postId);
447 * Removes the given post ID from the list of posts this Sone likes.
451 * @return This Sone (for method chaining)
453 Sone removeLikedPostId(String postId);
456 * Returns the IDs of all liked replies.
458 * @return All liked repliesā IDs
460 Set<String> getLikedReplyIds();
463 * Sets the IDs of all liked replies.
465 * @param likedReplyIds
466 * All liked repliesā IDs
467 * @return This Sone (for method chaining)
469 Sone setLikeReplyIds(Set<String> likedReplyIds);
472 * Checks whether the given reply ID is liked by this Sone.
475 * The ID of the reply
476 * @return {@code true} if this Sone likes the given reply, {@code false}
479 boolean isLikedReplyId(String replyId);
482 * Adds the given reply ID to the list of replies this Sone likes.
485 * The ID of the reply
486 * @return This Sone (for method chaining)
488 Sone addLikedReplyId(String replyId);
491 * Removes the given post ID from the list of replies this Sone likes.
494 * The ID of the reply
495 * @return This Sone (for method chaining)
497 Sone removeLikedReplyId(String replyId);
500 * Returns the root album that contains all visible albums of this Sone.
502 * @return The root album of this Sone
504 Album getRootAlbum();
507 * Returns Sone-specific options.
509 * @return The options of this Sone
511 SoneOptions getOptions();
514 * Sets the options of this Sone.
517 * The options of this Sone
519 /* TODO - remove this method again, maybe add an option provider */
520 void setOptions(SoneOptions options);