X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fnet%2Fpterodactylus%2Fsone%2Fdata%2FSone.java;h=dd31c03312f6e7f985f3f2cdcb30ed51d4739558;hb=refs%2Fheads%2Fnew-database-38;hp=bb36a9cec9558978c5bbd76a9c3825252f15bc47;hpb=87386f93e655178eed6024babd50bf236ab882ff;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 bb36a9c..28a5afa 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–2012 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,133 +17,344 @@ package net.pterodactylus.sone.data; -import java.util.Collections; -import java.util.HashSet; +import java.util.Collection; +import java.util.Comparator; +import java.util.List; import java.util.Set; -import java.util.UUID; +import net.pterodactylus.sone.core.Core; +import net.pterodactylus.sone.core.Options; +import net.pterodactylus.sone.freenet.wot.Identity; +import net.pterodactylus.sone.freenet.wot.OwnIdentity; +import net.pterodactylus.sone.template.SoneAccessor; +import net.pterodactylus.util.collection.filter.Filter; import freenet.keys.FreenetURI; /** - * A Sone defines everything about a user: the {@link User} itself, her profile, - * her status updates. + * A Sone defines everything about a user: her profile, her status updates, her + * replies, her likes and dislikes, etc. + *

+ * Operations that modify the Sone need to synchronize on the Sone in question. * * @author David ‘Bombe’ Roden */ -public class Sone { +public interface Sone extends Fingerprintable, Comparable { - /** A GUID for this Sone. */ - private final UUID id; - - /** The name of this Sone. */ - private final String name; + /** + * Enumeration for the possible states of a {@link Sone}. + * + * @author David ‘Bombe’ Roden + */ + public enum SoneStatus { - /** The URI under which the Sone is stored in Freenet. */ - private final FreenetURI requestUri; + /** The Sone is unknown, i.e. not yet downloaded. */ + unknown, - /** 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 idle, i.e. not being downloaded or inserted. */ + idle, - /** All friend Sones. */ - private final Set friendSones = new HashSet(); + /** The Sone is currently being inserted. */ + inserting, - /** Modification count. */ - private volatile long modificationCounter = 0; + /** The Sone is currently being downloaded. */ + downloading, + } /** - * Creates a new Sone. + * The possible values for the “show custom avatars” option. * - * @param id - * The ID of this Sone - * @param name - * The name of the Sone - * @param requestUri - * The request URI of the Sone + * @author David ‘Bombe’ Roden */ - public Sone(UUID id, String name, FreenetURI requestUri) { - this(id, name, requestUri, null); + public static enum ShowCustomAvatars { + + /** Never show custom avatars. */ + NEVER, + + /** Only show custom avatars of followed Sones. */ + FOLLOWED, + + /** Only show custom avatars of Sones you manually trust. */ + MANUALLY_TRUSTED, + + /** Only show custom avatars of automatically trusted Sones. */ + TRUSTED, + + /** Always show custom avatars. */ + ALWAYS, + } + /** comparator that sorts Sones by their nice name. */ + public static final Comparator NICE_NAME_COMPARATOR = new Comparator() { + + @Override + public int compare(Sone leftSone, Sone rightSone) { + int diff = SoneAccessor.getNiceName(leftSone).compareToIgnoreCase(SoneAccessor.getNiceName(rightSone)); + if (diff != 0) { + return diff; + } + return leftSone.getId().compareToIgnoreCase(rightSone.getId()); + } + + }; + /** - * Creates a new Sone. - * - * @param id - * The ID of this Sone - * @param name - * The name of the Sone - * @param requestUri - * The request URI of the Sone - * @param insertUri - * The insert URI of the Sone + * Comparator that sorts Sones by last activity (least recent active first). */ - public Sone(UUID id, String name, FreenetURI requestUri, FreenetURI insertUri) { - this.id = id; - this.name = name; - this.requestUri = requestUri; - this.insertUri = insertUri; - } + public static final Comparator LAST_ACTIVITY_COMPARATOR = new Comparator() { + + @Override + public int compare(Sone firstSone, Sone secondSone) { + return (int) Math.min(Integer.MAX_VALUE, Math.max(Integer.MIN_VALUE, secondSone.getTime() - firstSone.getTime())); + } + }; + + /** Comparator that sorts Sones by numbers of posts (descending). */ + public static final Comparator POST_COUNT_COMPARATOR = new Comparator() { + + /** + * {@inheritDoc} + */ + @Override + public int compare(Sone leftSone, Sone rightSone) { + return (leftSone.getPosts().size() != rightSone.getPosts().size()) ? (rightSone.getPosts().size() - leftSone.getPosts().size()) : (rightSone.getReplies().size() - leftSone.getReplies().size()); + } + }; + + /** Comparator that sorts Sones by number of images (descending). */ + public static final Comparator IMAGE_COUNT_COMPARATOR = new Comparator() { + + /** + * {@inheritDoc} + */ + @Override + public int compare(Sone leftSone, Sone rightSone) { + return rightSone.getAllImages().size() - leftSone.getAllImages().size(); + } + }; + + /** Filter to remove Sones that have not been downloaded. */ + public static final Filter EMPTY_SONE_FILTER = new Filter() { + + @Override + public boolean filterObject(Sone sone) { + return sone.getTime() != 0; + } + }; + + /** Filter that matches all {@link Core#getLocalSones() local Sones}. */ + public static final Filter LOCAL_SONE_FILTER = new Filter() { + + @Override + public boolean filterObject(Sone sone) { + return sone.getIdentity() instanceof OwnIdentity; + } + + }; + + /** Filter that matches Sones that have at least one album. */ + public static final Filter HAS_ALBUM_FILTER = new Filter() { + + @Override + public boolean filterObject(Sone sone) { + return !sone.getAlbums().isEmpty(); + } + }; // // ACCESSORS // /** - * Returns the ID of this Sone. + * Returns the identity of this Sone. * - * @return The ID of this Sone + * @return The identity of this Sone */ - public String getId() { - return id.toString(); - } + public String getId(); + + /** + * Returns the identity of this Sone. + * + * @return The identity of this Sone + */ + public Identity getIdentity(); + + /** + * Sets the identity of this Sone. The {@link Identity#getId() ID} of the + * identity has to match this Sone’s {@link #getId()}. + * + * @param identity + * The identity of this Sone + * @return This Sone (for method chaining) + * @throws IllegalArgumentException + * if the ID of the identity does not match this Sone’s ID + */ + public Sone setIdentity(Identity identity) throws IllegalArgumentException; + + /** + * Returns whether this Sone is local. + * + * @return {@code true} if this Sone is local, {@code false} otherwise + */ + public boolean isLocal(); /** * Returns the name of this Sone. * * @return The name of this Sone */ - public String getName() { - return name; - } + public String getName(); /** * Returns the request URI of this Sone. * * @return The request URI of this Sone */ - public FreenetURI getRequestUri() { - return requestUri; - } + public FreenetURI getRequestUri(); + + /** + * Sets the request URI of this Sone. + * + * @param requestUri + * The request URI of this Sone + * @return This Sone (for method chaining) + */ + public Sone setRequestUri(FreenetURI requestUri); /** * Returns the insert URI of this Sone. * * @return The insert URI of this Sone */ - public FreenetURI getInsertUri() { - return insertUri; - } + public FreenetURI getInsertUri(); + + /** + * Sets the insert URI of this Sone. + * + * @param insertUri + * The insert URI of this Sone + * @return This Sone (for method chaining) + */ + public Sone setInsertUri(FreenetURI insertUri); + + /** + * Returns the latest edition of this Sone. + * + * @return The latest edition of this Sone + */ + public 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 + */ + public 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) + */ + public 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) + */ + public Sone setTime(long time); + + /** + * Returns the status of this Sone. + * + * @return The status of this Sone + */ + public 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} + */ + public Sone setStatus(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 + */ + public 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 + */ + public void setProfile(Profile profile); + + /** + * Returns the client used by this Sone. + * + * @return The client used by this Sone, or {@code null} + */ + public 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) + */ + public Sone setClient(Client client); + + /** + * Returns whether this Sone is known. + * + * @return {@code true} if this Sone is known, {@code false} otherwise + */ + public boolean isKnown(); + + /** + * Sets whether this Sone is known. + * + * @param known + * {@code true} if this Sone is known, {@code false} otherwise + * @return This Sone + */ + public 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); - } + public Collection getFriends(); /** * Returns whether this Sone has the given Sone as a friend Sone. * - * @param friendSone - * The friend Sone to check for + * @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); - } + public boolean hasFriend(String friendSoneId); /** * Adds the given Sone as a friend Sone. @@ -152,56 +363,246 @@ public class Sone { * The friend Sone to add * @return This Sone (for method chaining) */ - public synchronized Sone addFriendSone(Sone friendSone) { - if (friendSones.add(friendSone)) { - modificationCounter++; - } - return this; - } + public Sone addFriend(String friendSone); /** * Removes the given Sone as a friend Sone. * - * @param friendSone - * The friend Sone to remove + * @param friendSoneId + * The ID of the friend Sone to remove * @return This Sone (for method chaining) */ - public synchronized Sone removeFriendSone(Sone friendSone) { - if (friendSones.remove(friendSone)) { - modificationCounter++; - } - return this; - } + public Sone removeFriend(String friendSoneId); /** - * Returns the modification counter. + * Returns the list of posts of this Sone, sorted by time, newest first. * - * @return The modification counter + * @return All posts of this Sone */ - public synchronized long getModificationCounter() { - return modificationCounter; - } + public List getPosts(); /** - * Sets the modification counter. + * Sets all posts of this Sone at once. * - * @param modificationCounter - * The new modification counter + * @param posts + * The new (and only) posts of this Sone + * @return This Sone (for method chaining) */ - public synchronized void setModificationCounter(long modificationCounter) { - this.modificationCounter = modificationCounter; - } + public Sone setPosts(Collection posts); - // - // OBJECT METHODS - // + /** + * 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 + */ + public void addPost(Post post); /** - * {@inheritDoc} + * Removes the given post from this Sone. + * + * @param post + * The post to remove */ - @Override - public int hashCode() { - return id.hashCode(); - } + public void removePost(Post post); + + /** + * Returns all replies this Sone made. + * + * @return All replies this Sone made + */ + public Set getReplies(); + + /** + * Sets all replies of this Sone at once. + * + * @param replies + * The new (and only) replies of this Sone + * @return This Sone (for method chaining) + */ + public Sone setReplies(Collection replies); + + /** + * 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 + */ + public void addReply(PostReply reply); + + /** + * Removes a reply from this Sone. + * + * @param reply + * The reply to remove + */ + public void removeReply(PostReply reply); + + /** + * Returns the IDs of all liked posts. + * + * @return All liked posts’ IDs + */ + public Set getLikedPostIds(); + + /** + * Sets the IDs of all liked posts. + * + * @param likedPostIds + * All liked posts’ IDs + * @return This Sone (for method chaining) + */ + public Sone setLikePostIds(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 + */ + public boolean isLikedPostId(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) + */ + public Sone addLikedPostId(String postId); + + /** + * Removes the given post ID from the list of posts this Sone likes. + * + * @param postId + * The ID of the post + * @return This Sone (for method chaining) + */ + public Sone removeLikedPostId(String postId); + + /** + * Returns the IDs of all liked replies. + * + * @return All liked replies’ IDs + */ + public Set getLikedReplyIds(); + + /** + * Sets the IDs of all liked replies. + * + * @param likedReplyIds + * All liked replies’ IDs + * @return This Sone (for method chaining) + */ + public Sone setLikeReplyIds(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 + */ + public boolean isLikedReplyId(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) + */ + public Sone addLikedReplyId(String replyId); + + /** + * Removes the given post ID from the list of replies this Sone likes. + * + * @param replyId + * The ID of the reply + * @return This Sone (for method chaining) + */ + public Sone removeLikedReplyId(String replyId); + + /** + * Returns the albums of this Sone. + * + * @return The albums of this Sone + */ + public List getAlbums(); + + /** + * Returns a flattened list of all albums of this Sone. The resulting list + * contains parent albums before child albums so that the resulting list can + * be parsed in a single pass. + * + * @return The flattened albums + */ + public List getAllAlbums(); + + /** + * Returns all images of a Sone. Images of a album are inserted into this + * list before images of all child albums. + * + * @return The list of all images + */ + public List getAllImages(); + + /** + * Adds an album to this Sone. + * + * @param album + * The album to add + */ + public void addAlbum(Album album); + + /** + * Sets the albums of this Sone. + * + * @param albums + * The albums of this Sone + */ + public void setAlbums(Collection albums); + + /** + * Removes an album from this Sone. + * + * @param album + * The album to remove + */ + public void removeAlbum(Album album); + + /** + * Moves the given album up in this album’s albums. If the album is already + * the first album, nothing happens. + * + * @param album + * The album to move up + * @return The album that the given album swapped the place with, or + * null if the album did not change its place + */ + public Album moveAlbumUp(Album album); + + /** + * Moves the given album down in this album’s albums. If the album is + * already the last album, nothing happens. + * + * @param album + * The album to move down + * @return The album that the given album swapped the place with, or + * null if the album did not change its place + */ + public Album moveAlbumDown(Album album); + + /** + * Returns Sone-specific options. + * + * @return The options of this Sone + */ + public Options getOptions(); }