X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fnet%2Fpterodactylus%2Fsone%2Fdata%2FSone.java;h=715d95b01e574f9927a4d45144963a7d7e036448;hb=07d3fa7dac96e8a5eff41487d647974df8c26f8d;hp=b969bd4f9234b8acd2373ae245f052ae051bd60e;hpb=2284032867d6f03bf4eb7c70204ec33bd39ed006;p=Sone.git diff --git a/src/main/java/net/pterodactylus/sone/data/Sone.java b/src/main/java/net/pterodactylus/sone/data/Sone.java index b969bd4..836baa1 100644 --- a/src/main/java/net/pterodactylus/sone/data/Sone.java +++ b/src/main/java/net/pterodactylus/sone/data/Sone.java @@ -1,5 +1,5 @@ /* - * FreenetSone - Sone.java - Copyright © 2010 David Roden + * Sone - Sone.java - Copyright © 2010–2020 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 @@ -17,143 +17,408 @@ package net.pterodactylus.sone.data; +import static com.google.common.collect.FluentIterable.from; +import static net.pterodactylus.sone.data.Album.FLATTENER; +import static net.pterodactylus.sone.data.Album.IMAGES; + +import java.util.Collection; import java.util.Collections; -import java.util.HashSet; +import java.util.List; import java.util.Set; -import java.util.UUID; + +import javax.annotation.Nonnull; +import javax.annotation.Nullable; + +import net.pterodactylus.sone.freenet.wot.Identity; import freenet.keys.FreenetURI; +import com.google.common.base.Function; + /** - * A Sone defines everything about a user: the {@link User} itself, her profile, - * her status updates. - * - * @author David ‘Bombe’ Roden + * A Sone defines everything about a user: her profile, her status updates, her + * replies, her likes and dislikes, etc. */ -public class Sone { +public interface Sone extends Identified, Fingerprintable, Comparable { + + /** + * Enumeration for the possible states of a {@link Sone}. + */ + public enum SoneStatus { + + /** The Sone is unknown, i.e. not yet downloaded. */ + unknown, - /** A GUID for this Sone. */ - private final UUID id = UUID.randomUUID(); + /** The Sone is idle, i.e. not being downloaded or inserted. */ + idle, - /** The URI under which the Sone is stored in Freenet. */ - private final FreenetURI requestUri; + /** The Sone is currently being inserted. */ + inserting, - /** The URI used to insert a new version of this Sone. */ - /* This will be null for remote Sones! */ - private final FreenetURI insertUri; + /** The Sone is currently being downloaded. */ + downloading, + } + + public static final Function> toAllAlbums = new Function>() { + @Override + public List apply(@Nullable Sone sone) { + return (sone == null) ? Collections.emptyList() : FLATTENER.apply( + sone.getRootAlbum()); + } + }; - /** All friend Sones. */ - private final Set friendSones = new HashSet(); + public static final Function> toAllImages = new Function>() { + @Override + public List apply(@Nullable Sone sone) { + return (sone == null) ? Collections.emptyList() : + from(FLATTENER.apply(sone.getRootAlbum())) + .transformAndConcat(IMAGES).toList(); + } + }; /** - * Creates a new Sone. + * Returns the identity of this Sone. * - * @param requestUri - * The request URI of the Sone + * @return The identity of this Sone */ - public Sone(FreenetURI requestUri) { - this(requestUri, null); - } + @Nonnull + Identity getIdentity(); /** - * Creates a new Sone. + * Returns the name of this Sone. * - * @param requestUri - * The request URI of the Sone - * @param insertUri - * The insert URI of the Sone + * @return The name of this Sone */ - public Sone(FreenetURI requestUri, FreenetURI insertUri) { - this.requestUri = requestUri; - this.insertUri = insertUri; - } - - // - // ACCESSORS - // + @Nonnull + String getName(); /** - * Returns the ID of this Sone. + * Returns whether this Sone is a local Sone. * - * @return The ID of this Sone + * @return {@code true} if this Sone is a local Sone, {@code false} otherwise */ - public String getId() { - return id.toString(); - } + boolean isLocal(); /** * Returns the request URI of this Sone. * * @return The request URI of this Sone */ - public FreenetURI getRequestUri() { - return requestUri; - } + @Nonnull + FreenetURI getRequestUri(); /** - * Returns the insert URI of this Sone. + * Returns the latest edition of this Sone. * - * @return The insert URI of this Sone + * @return The latest edition of this Sone */ - public FreenetURI getInsertUri() { - return insertUri; - } + long getLatestEdition(); + + /** + * Sets the latest edition of this Sone. If the given latest edition is not + * greater than the current latest edition, the latest edition of this Sone is + * not changed. + * + * @param latestEdition + * The latest edition of this Sone + */ + void setLatestEdition(long latestEdition); + + /** + * Return the time of the last inserted update of this Sone. + * + * @return The time of the update (in milliseconds since Jan 1, 1970 UTC) + */ + long getTime(); + + /** + * Sets the time of the last inserted update of this Sone. + * + * @param time + * The time of the update (in milliseconds since Jan 1, 1970 UTC) + * @return This Sone (for method chaining) + */ + @Nonnull + Sone setTime(long time); + + /** + * Returns the status of this Sone. + * + * @return The status of this Sone + */ + @Nonnull + SoneStatus getStatus(); + + /** + * Sets the new status of this Sone. + * + * @param status + * The new status of this Sone + * @return This Sone + * @throws IllegalArgumentException + * if {@code status} is {@code null} + */ + @Nonnull + Sone setStatus(@Nonnull SoneStatus status); + + /** + * Returns a copy of the profile. If you want to update values in the profile + * of this Sone, update the values in the returned {@link Profile} and use + * {@link #setProfile(Profile)} to change the profile in this Sone. + * + * @return A copy of the profile + */ + @Nonnull + Profile getProfile(); + + /** + * Sets the profile of this Sone. A copy of the given profile is stored so that + * subsequent modifications of the given profile are not reflected in this + * Sone! + * + * @param profile + * The profile to set + */ + void setProfile(@Nonnull Profile profile); + + /** + * Returns the client used by this Sone. + * + * @return The client used by this Sone, or {@code null} + */ + @Nullable + Client getClient(); + + /** + * Sets the client used by this Sone. + * + * @param client + * The client used by this Sone, or {@code null} + * @return This Sone (for method chaining) + */ + @Nonnull + Sone setClient(@Nullable Client client); + + /** + * Returns whether this Sone is known. + * + * @return {@code true} if this Sone is known, {@code false} otherwise + */ + boolean isKnown(); + + /** + * Sets whether this Sone is known. + * + * @param known + * {@code true} if this Sone is known, {@code false} otherwise + * @return This Sone + */ + @Nonnull + Sone setKnown(boolean known); /** * Returns all friend Sones of this Sone. * * @return The friend Sones of this Sone */ - public Set getFriendSones() { - return Collections.unmodifiableSet(friendSones); - } + @Nonnull + Collection getFriends(); /** * Returns whether this Sone has the given Sone as a friend Sone. * - * @param friendSone - * The friend Sone to check for - * @return {@code true} if this Sone has the given Sone as a friend, - * {@code false} otherwise + * @param friendSoneId + * The ID of the Sone to check for + * @return {@code true} if this Sone has the given Sone as a friend, {@code + * false} otherwise */ - public boolean hasFriendSone(Sone friendSone) { - return friendSones.contains(friendSone); - } + boolean hasFriend(@Nonnull String friendSoneId); /** - * Adds the given Sone as a friend Sone. + * Returns the list of posts of this Sone, sorted by time, newest first. * - * @param friendSone - * The friend Sone to add + * @return All posts of this Sone + */ + @Nonnull + List getPosts(); + + /** + * Sets all posts of this Sone at once. + * + * @param posts + * The new (and only) posts of this Sone * @return This Sone (for method chaining) */ - public Sone addFriendSone(Sone friendSone) { - friendSones.add(friendSone); - return this; - } + @Nonnull + Sone setPosts(@Nonnull Collection posts); + + /** + * Adds the given post to this Sone. The post will not be added if its {@link + * Post#getSone() Sone} is not this Sone. + * + * @param post + * The post to add + */ + void addPost(@Nonnull Post post); + + /** + * Removes the given post from this Sone. + * + * @param post + * The post to remove + */ + void removePost(@Nonnull Post post); + + /** + * Returns all replies this Sone made. + * + * @return All replies this Sone made + */ + @Nonnull + Set getReplies(); /** - * Removes the given Sone as a friend Sone. + * Sets all replies of this Sone at once. * - * @param friendSone - * The friend Sone to remove + * @param replies + * The new (and only) replies of this Sone * @return This Sone (for method chaining) */ - public Sone removeFriendSone(Sone friendSone) { - friendSones.remove(friendSone); - return this; - } + @Nonnull + Sone setReplies(@Nonnull Collection replies); - // - // OBJECT METHODS - // + /** + * Adds a reply to this Sone. If the given reply was not made by this Sone, + * nothing is added to this Sone. + * + * @param reply + * The reply to add + */ + void addReply(@Nonnull PostReply reply); /** - * {@inheritDoc} + * Removes a reply from this Sone. + * + * @param reply + * The reply to remove */ - @Override - public int hashCode() { - return id.hashCode(); - } + void removeReply(@Nonnull PostReply reply); + + /** + * Returns the IDs of all liked posts. + * + * @return All liked posts’ IDs + */ + @Nonnull + Set getLikedPostIds(); + + /** + * Sets the IDs of all liked posts. + * + * @param likedPostIds + * All liked posts’ IDs + * @return This Sone (for method chaining) + */ + @Nonnull + Sone setLikePostIds(@Nonnull Set likedPostIds); + + /** + * Checks whether the given post ID is liked by this Sone. + * + * @param postId + * The ID of the post + * @return {@code true} if this Sone likes the given post, {@code false} + * otherwise + */ + boolean isLikedPostId(@Nonnull String postId); + + /** + * Adds the given post ID to the list of posts this Sone likes. + * + * @param postId + * The ID of the post + * @return This Sone (for method chaining) + */ + @Nonnull + Sone addLikedPostId(@Nonnull String postId); + + /** + * Removes the given post ID from the list of posts this Sone likes. + * + * @param postId + * The ID of the post + */ + void removeLikedPostId(@Nonnull String postId); + + /** + * Returns the IDs of all liked replies. + * + * @return All liked replies’ IDs + */ + @Nonnull + Set getLikedReplyIds(); + + /** + * Sets the IDs of all liked replies. + * + * @param likedReplyIds + * All liked replies’ IDs + * @return This Sone (for method chaining) + */ + @Nonnull + Sone setLikeReplyIds(@Nonnull Set likedReplyIds); + + /** + * Checks whether the given reply ID is liked by this Sone. + * + * @param replyId + * The ID of the reply + * @return {@code true} if this Sone likes the given reply, {@code false} + * otherwise + */ + boolean isLikedReplyId(@Nonnull String replyId); + + /** + * Adds the given reply ID to the list of replies this Sone likes. + * + * @param replyId + * The ID of the reply + * @return This Sone (for method chaining) + */ + @Nonnull + Sone addLikedReplyId(@Nonnull String replyId); + + /** + * Removes the given post ID from the list of replies this Sone likes. + * + * @param replyId + * The ID of the reply + */ + void removeLikedReplyId(@Nonnull String replyId); + + /** + * Returns the root album that contains all visible albums of this Sone. + * + * @return The root album of this Sone + */ + @Nonnull + Album getRootAlbum(); + + /** + * Returns Sone-specific options. + * + * @return The options of this Sone + */ + @Nonnull + SoneOptions getOptions(); + + /** + * Sets the options of this Sone. + * + * @param options + * The options of this Sone + */ + /* TODO - remove this method again, maybe add an option provider */ + void setOptions(@Nonnull SoneOptions options); }