/*
- * FreenetSone - Sone.java - Copyright © 2010 David Roden
+ * Sone - Sone.java - Copyright © 2010 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
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
-import java.util.HashSet;
import java.util.List;
import java.util.Set;
-import java.util.UUID;
+import java.util.concurrent.CopyOnWriteArrayList;
+import java.util.concurrent.CopyOnWriteArraySet;
import java.util.logging.Level;
import java.util.logging.Logger;
+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.filter.Filter;
import net.pterodactylus.util.logging.Logging;
+import net.pterodactylus.util.validation.Validation;
import freenet.keys.FreenetURI;
/**
*
* @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
*/
-public class Sone {
+public class Sone implements Fingerprintable, Comparable<Sone> {
+
+ /**
+ * Enumeration for the possible states of a {@link Sone}.
+ *
+ * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
+ */
+ public enum SoneStatus {
+
+ /** The Sone is unknown, i.e. not yet downloaded. */
+ unknown,
+
+ /** The Sone is idle, i.e. not being downloaded or inserted. */
+ idle,
+
+ /** The Sone is currently being inserted. */
+ inserting,
+
+ /** The Sone is currently being downloaded. */
+ downloading,
+ }
+
+ /**
+ * The possible values for the “show custom avatars” option.
+ *
+ * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
+ */
+ 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<Sone> NICE_NAME_COMPARATOR = new Comparator<Sone>() {
+
+ @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());
+ }
+
+ };
+
+ /**
+ * Comparator that sorts Sones by last activity (least recent active first).
+ */
+ public static final Comparator<Sone> LAST_ACTIVITY_COMPARATOR = new Comparator<Sone>() {
+
+ @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<Sone> POST_COUNT_COMPARATOR = new Comparator<Sone>() {
+
+ /**
+ * {@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<Sone> IMAGE_COUNT_COMPARATOR = new Comparator<Sone>() {
+
+ /**
+ * {@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<Sone> EMPTY_SONE_FILTER = new Filter<Sone>() {
+
+ @Override
+ public boolean filterObject(Sone sone) {
+ return sone.getTime() != 0;
+ }
+ };
+
+ /** Filter that matches all {@link Core#isLocalSone(Sone) local Sones}. */
+ public static final Filter<Sone> LOCAL_SONE_FILTER = new Filter<Sone>() {
+
+ @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<Sone> HAS_ALBUM_FILTER = new Filter<Sone>() {
+
+ @Override
+ public boolean filterObject(Sone sone) {
+ return !sone.getAlbums().isEmpty();
+ }
+ };
/** The logger. */
private static final Logger logger = Logging.getLogger(Sone.class);
- /** A GUID for this Sone. */
- private final UUID id;
+ /** The ID of this Sone. */
+ private final String id;
- /** The name of this Sone. */
- private volatile String name;
+ /** The identity of this Sone. */
+ private Identity identity;
/** The URI under which the Sone is stored in Freenet. */
private volatile FreenetURI requestUri;
/* This will be null for remote Sones! */
private volatile FreenetURI insertUri;
+ /** The latest edition of the Sone. */
+ private volatile long latestEdition;
+
/** The time of the last inserted update. */
private volatile long time;
+ /** The status of this Sone. */
+ private volatile SoneStatus status = SoneStatus.unknown;
+
/** The profile of this Sone. */
- private volatile Profile profile;
+ private volatile Profile profile = new Profile(this);
+
+ /** The client used by the Sone. */
+ private volatile Client client;
+
+ /** Whether this Sone is known. */
+ private volatile boolean known;
/** All friend Sones. */
- private final Set<Sone> friendSones = Collections.synchronizedSet(new HashSet<Sone>());
+ private final Set<String> friendSones = new CopyOnWriteArraySet<String>();
/** All posts. */
- private final Set<Post> posts = Collections.synchronizedSet(new HashSet<Post>());
+ private final Set<Post> posts = new CopyOnWriteArraySet<Post>();
/** All replies. */
- private final Set<Reply> replies = Collections.synchronizedSet(new HashSet<Reply>());
-
- /** The IDs of all blocked Sones. */
- private final Set<String> blockedSoneIds = Collections.synchronizedSet(new HashSet<String>());
+ private final Set<PostReply> replies = new CopyOnWriteArraySet<PostReply>();
/** The IDs of all liked posts. */
- private final Set<String> likedPostIds = Collections.synchronizedSet(new HashSet<String>());
+ private final Set<String> likedPostIds = new CopyOnWriteArraySet<String>();
/** The IDs of all liked replies. */
- private final Set<String> likedReplyIds = Collections.synchronizedSet(new HashSet<String>());
+ private final Set<String> likedReplyIds = new CopyOnWriteArraySet<String>();
- /** Modification count. */
- private volatile long modificationCounter = 0;
+ /** The albums of this Sone. */
+ private final List<Album> albums = new CopyOnWriteArrayList<Album>();
+
+ /** Sone-specific options. */
+ private final Options options = new Options();
/**
* Creates a new Sone.
*
* @param id
- * The ID of this Sone
+ * The ID of the Sone
*/
public Sone(String id) {
- this.id = UUID.fromString(id);
+ this.id = id;
}
//
//
/**
- * 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();
+ return id;
}
/**
- * Returns the name of this Sone.
+ * Returns the identity of this Sone.
*
- * @return The name of this Sone
+ * @return The identity of this Sone
*/
- public String getName() {
- return name;
+ public Identity getIdentity() {
+ return identity;
}
/**
- * Sets the name of this Sone.
+ * Sets the identity of this Sone. The {@link Identity#getId() ID} of the
+ * identity has to match this Sone’s {@link #getId()}.
*
- * @param name
- * The name of this Sone
- * @return This sone (for method chaining)
+ * @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 setName(String name) {
- this.name = name;
+ public Sone setIdentity(Identity identity) throws IllegalArgumentException {
+ if (!identity.getId().equals(id)) {
+ throw new IllegalArgumentException("Identity’s ID does not match Sone’s ID!");
+ }
+ this.identity = identity;
return this;
}
/**
+ * Returns the name of this Sone.
+ *
+ * @return The name of this Sone
+ */
+ public String getName() {
+ return (identity != null) ? identity.getNickname() : null;
+ }
+
+ /**
* Returns the request URI of this Sone.
*
* @return The request URI of this Sone
*/
public FreenetURI getRequestUri() {
- return requestUri;
+ return (requestUri != null) ? requestUri.setSuggestedEdition(latestEdition) : null;
}
/**
*/
public Sone setRequestUri(FreenetURI requestUri) {
if (this.requestUri == null) {
- this.requestUri = requestUri;
- updateEditions();
+ this.requestUri = requestUri.setKeyType("USK").setDocName("Sone").setMetaString(new String[0]);
return this;
}
if (!this.requestUri.equalsKeypair(requestUri)) {
- logger.log(Level.WARNING, "Request URI %s tried to overwrite %s!", new Object[] { requestUri, this.requestUri });
+ logger.log(Level.WARNING, String.format("Request URI %s tried to overwrite %s!", requestUri, this.requestUri));
return this;
}
- long latestEdition = requestUri.getEdition();
- if ((latestEdition > this.requestUri.getEdition()) || (latestEdition > this.requestUri.getSuggestedEdition())) {
- this.requestUri.setSuggestedEdition(latestEdition);
- }
return this;
}
* @return The insert URI of this Sone
*/
public FreenetURI getInsertUri() {
- return insertUri;
+ return (insertUri != null) ? insertUri.setSuggestedEdition(latestEdition) : null;
}
/**
*/
public Sone setInsertUri(FreenetURI insertUri) {
if (this.insertUri == null) {
- this.insertUri = insertUri;
- updateEditions();
+ this.insertUri = insertUri.setKeyType("USK").setDocName("Sone").setMetaString(new String[0]);
return this;
}
if (!this.insertUri.equalsKeypair(insertUri)) {
- logger.log(Level.WARNING, "Request URI %s tried to overwrite %s!", new Object[] { insertUri, this.insertUri });
+ logger.log(Level.WARNING, String.format("Request URI %s tried to overwrite %s!", insertUri, this.insertUri));
return this;
}
- long latestEdition = insertUri.getEdition();
- if ((latestEdition > this.insertUri.getEdition()) || (latestEdition > this.insertUri.getSuggestedEdition())) {
- this.insertUri.setSuggestedEdition(latestEdition);
- }
return this;
}
/**
+ * Returns the latest edition of this Sone.
+ *
+ * @return The latest edition of this Sone
+ */
+ public long getLatestEdition() {
+ return latestEdition;
+ }
+
+ /**
+ * 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) {
+ if (!(latestEdition > this.latestEdition)) {
+ logger.log(Level.FINE, String.format("New latest edition %d is not greater than current latest edition %d!", latestEdition, this.latestEdition));
+ return;
+ }
+ this.latestEdition = 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)
}
/**
+ * Returns the status of this Sone.
+ *
+ * @return The status of this Sone
+ */
+ public SoneStatus getStatus() {
+ return status;
+ }
+
+ /**
+ * 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) {
+ Validation.begin().isNotNull("Sone Status", status).check();
+ this.status = status;
+ return this;
+ }
+
+ /**
* 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.
* @param profile
* The profile to set
*/
- public synchronized void setProfile(Profile profile) {
+ public void setProfile(Profile profile) {
this.profile = new Profile(profile);
- modificationCounter++;
}
/**
- * Returns all friend Sones of this Sone.
+ * Returns the client used by this Sone.
*
- * @return The friend Sones of this Sone
+ * @return The client used by this Sone, or {@code null}
*/
- public List<Sone> getFriends() {
- List<Sone> friends = new ArrayList<Sone>(friendSones);
- Collections.sort(friends, new Comparator<Sone>() {
-
- @Override
- public int compare(Sone leftSone, Sone rightSone) {
- int diff = SoneAccessor.getNiceName(leftSone).compareToIgnoreCase(SoneAccessor.getNiceName(rightSone));
- if (diff != 0) {
- return diff;
- }
- return (int) Math.max(Integer.MIN_VALUE, Math.min(Integer.MAX_VALUE, rightSone.getTime() - leftSone.getTime()));
- }
- });
- return friends;
+ public Client getClient() {
+ return client;
}
/**
- * Sets all friends of this Sone at once.
+ * Sets the client used by this Sone.
*
- * @param friends
- * The new (and only) friends of this Sone
+ * @param client
+ * The client used by this Sone, or {@code null}
* @return This Sone (for method chaining)
*/
- public Sone setFriends(Collection<Sone> friends) {
- friendSones.clear();
- friendSones.addAll(friends);
+ public Sone setClient(Client client) {
+ this.client = client;
+ return this;
+ }
+
+ /**
+ * Returns whether this Sone is known.
+ *
+ * @return {@code true} if this Sone is known, {@code false} otherwise
+ */
+ public boolean isKnown() {
+ return known;
+ }
+
+ /**
+ * 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) {
+ this.known = known;
return this;
}
/**
+ * Returns all friend Sones of this Sone.
+ *
+ * @return The friend Sones of this Sone
+ */
+ public List<String> getFriends() {
+ List<String> friends = new ArrayList<String>(friendSones);
+ return friends;
+ }
+
+ /**
* 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 hasFriend(Sone friendSone) {
- return friendSones.contains(friendSone);
+ public boolean hasFriend(String friendSoneId) {
+ return friendSones.contains(friendSoneId);
}
/**
* The friend Sone to add
* @return This Sone (for method chaining)
*/
- public Sone addFriend(Sone friendSone) {
- if (!friendSone.equals(this)) {
+ public Sone addFriend(String friendSone) {
+ if (!friendSone.equals(id)) {
friendSones.add(friendSone);
}
return this;
/**
* 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 Sone removeFriend(Sone friendSone) {
- friendSones.remove(friendSone);
+ public Sone removeFriend(String friendSoneId) {
+ friendSones.remove(friendSoneId);
return this;
}
* @return All posts of this Sone
*/
public List<Post> getPosts() {
- List<Post> sortedPosts = new ArrayList<Post>(posts);
- Collections.sort(sortedPosts, new Comparator<Post>() {
-
- @Override
- public int compare(Post leftPost, Post rightPost) {
- return (int) Math.max(Integer.MIN_VALUE, Math.min(Integer.MAX_VALUE, rightPost.getTime() - leftPost.getTime()));
- }
-
- });
+ List<Post> sortedPosts;
+ synchronized (this) {
+ sortedPosts = new ArrayList<Post>(posts);
+ }
+ Collections.sort(sortedPosts, Post.TIME_COMPARATOR);
return sortedPosts;
}
* The new (and only) posts of this Sone
* @return This Sone (for method chaining)
*/
- public synchronized Sone setPosts(Collection<Post> posts) {
- this.posts.clear();
- this.posts.addAll(posts);
- modificationCounter++;
+ public Sone setPosts(Collection<Post> posts) {
+ synchronized (this) {
+ this.posts.clear();
+ this.posts.addAll(posts);
+ }
return this;
}
* @param post
* The post to add
*/
- public synchronized void addPost(Post post) {
+ public void addPost(Post post) {
if (post.getSone().equals(this) && posts.add(post)) {
- logger.log(Level.FINEST, "Adding %s to “%s”.", new Object[] { post, getName() });
- modificationCounter++;
+ logger.log(Level.FINEST, String.format("Adding %s to “%s”.", post, getName()));
}
}
* @param post
* The post to remove
*/
- public synchronized void removePost(Post post) {
- if (post.getSone().equals(this) && posts.remove(post)) {
- modificationCounter++;
+ public void removePost(Post post) {
+ if (post.getSone().equals(this)) {
+ posts.remove(post);
}
}
*
* @return All replies this Sone made
*/
- public Set<Reply> getReplies() {
- logger.log(Level.FINEST, "Friends of %s: %s", new Object[] { this, friendSones });
+ public Set<PostReply> getReplies() {
return Collections.unmodifiableSet(replies);
}
* The new (and only) replies of this Sone
* @return This Sone (for method chaining)
*/
- public synchronized Sone setReplies(Collection<Reply> replies) {
+ public Sone setReplies(Collection<PostReply> replies) {
this.replies.clear();
this.replies.addAll(replies);
- modificationCounter++;
return this;
}
* @param reply
* The reply to add
*/
- public synchronized void addReply(Reply reply) {
- if (reply.getSone().equals(this) && replies.add(reply)) {
- modificationCounter++;
+ public void addReply(PostReply reply) {
+ if (reply.getSone().equals(this)) {
+ replies.add(reply);
}
}
* @param reply
* The reply to remove
*/
- public synchronized void removeReply(Reply reply) {
- if (reply.getSone().equals(this) && replies.remove(reply)) {
- modificationCounter++;
- }
- }
-
- /**
- * Returns the IDs of all blocked Sones. These Sones will not propagated
- * using the “known Sones” mechanism.
- *
- * @return The IDs of all blocked Sones
- */
- public Set<String> getBlockedSoneIds() {
- return Collections.unmodifiableSet(blockedSoneIds);
- }
-
- /**
- * Returns whether the given Sone ID is blocked.
- *
- * @param soneId
- * The Sone ID to check
- * @return {@code true} if the given Sone ID is blocked, {@code false}
- * otherwise
- */
- public boolean isSoneBlocked(String soneId) {
- return blockedSoneIds.contains(soneId);
- }
-
- /**
- * Adds the given ID to the list of blocked IDs.
- *
- * @param soneId
- * The Sone ID to block
- */
- public synchronized void addBlockedSoneId(String soneId) {
- if (blockedSoneIds.add(soneId)) {
- modificationCounter++;
- }
- }
-
- /**
- * Removes the given ID from the list of blocked IDs.
- *
- * @param soneId
- * The Sone ID to unblock
- */
- public synchronized void removeBlockedSoneId(String soneId) {
- if (blockedSoneIds.remove(soneId)) {
- modificationCounter++;
+ public void removeReply(PostReply reply) {
+ if (reply.getSone().equals(this)) {
+ replies.remove(reply);
}
}
* All liked posts’ IDs
* @return This Sone (for method chaining)
*/
- public synchronized Sone setLikePostIds(Set<String> likedPostIds) {
+ public Sone setLikePostIds(Set<String> likedPostIds) {
this.likedPostIds.clear();
this.likedPostIds.addAll(likedPostIds);
- modificationCounter++;
return this;
}
* The ID of the post
* @return This Sone (for method chaining)
*/
- public synchronized Sone addLikedPostId(String postId) {
- if (likedPostIds.add(postId)) {
- modificationCounter++;
- }
+ public Sone addLikedPostId(String postId) {
+ likedPostIds.add(postId);
return this;
}
* The ID of the post
* @return This Sone (for method chaining)
*/
- public synchronized Sone removeLikedPostId(String postId) {
- if (likedPostIds.remove(postId)) {
- modificationCounter++;
- }
+ public Sone removeLikedPostId(String postId) {
+ likedPostIds.remove(postId);
return this;
}
* All liked replies’ IDs
* @return This Sone (for method chaining)
*/
- public synchronized Sone setLikeReplyIds(Set<String> likedReplyIds) {
+ public Sone setLikeReplyIds(Set<String> likedReplyIds) {
this.likedReplyIds.clear();
this.likedReplyIds.addAll(likedReplyIds);
- modificationCounter++;
return this;
}
* The ID of the reply
* @return This Sone (for method chaining)
*/
- public synchronized Sone addLikedReplyId(String replyId) {
- if (likedReplyIds.add(replyId)) {
- modificationCounter++;
- }
+ public Sone addLikedReplyId(String replyId) {
+ likedReplyIds.add(replyId);
return this;
}
* The ID of the reply
* @return This Sone (for method chaining)
*/
- public synchronized Sone removeLikedReplyId(String replyId) {
- if (likedReplyIds.remove(replyId)) {
- modificationCounter++;
- }
+ public Sone removeLikedReplyId(String replyId) {
+ likedReplyIds.remove(replyId);
return this;
}
/**
- * Returns the modification counter.
+ * Returns the albums of this Sone.
*
- * @return The modification counter
+ * @return The albums of this Sone
*/
- public synchronized long getModificationCounter() {
- return modificationCounter;
+ public List<Album> getAlbums() {
+ return Collections.unmodifiableList(albums);
}
/**
- * Sets the modification counter.
+ * 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.
*
- * @param modificationCounter
- * The new modification counter
+ * @return The flattened albums
*/
- public synchronized void setModificationCounter(long modificationCounter) {
- this.modificationCounter = modificationCounter;
+ public List<Album> getAllAlbums() {
+ List<Album> flatAlbums = new ArrayList<Album>();
+ flatAlbums.addAll(albums);
+ int lastAlbumIndex = 0;
+ while (lastAlbumIndex < flatAlbums.size()) {
+ int previousAlbumCount = flatAlbums.size();
+ for (Album album : new ArrayList<Album>(flatAlbums.subList(lastAlbumIndex, flatAlbums.size()))) {
+ flatAlbums.addAll(album.getAlbums());
+ }
+ lastAlbumIndex = previousAlbumCount;
+ }
+ return flatAlbums;
}
/**
- * Updates the suggested edition in both the request URI and the insert URI.
+ * Returns all images of a Sone. Images of a album are inserted into this
+ * list before images of all child albums.
*
- * @param latestEdition
- * The latest edition to update the URIs to
+ * @return The list of all images
*/
- public void updateUris(long latestEdition) {
- if ((requestUri != null) && (requestUri.getEdition() < latestEdition)) {
- requestUri = requestUri.setSuggestedEdition(latestEdition);
+ public List<Image> getAllImages() {
+ List<Image> allImages = new ArrayList<Image>();
+ for (Album album : getAllAlbums()) {
+ allImages.addAll(album.getImages());
}
- if ((insertUri != null) && (insertUri.getEdition() < latestEdition)) {
- insertUri = insertUri.setSuggestedEdition(latestEdition);
+ return allImages;
+ }
+
+ /**
+ * Adds an album to this Sone.
+ *
+ * @param album
+ * The album to add
+ */
+ public void addAlbum(Album album) {
+ Validation.begin().isNotNull("Album", album).check().isEqual("Album Owner", album.getSone(), this).check();
+ albums.add(album);
+ }
+
+ /**
+ * Sets the albums of this Sone.
+ *
+ * @param albums
+ * The albums of this Sone
+ */
+ public void setAlbums(Collection<? extends Album> albums) {
+ Validation.begin().isNotNull("Albums", albums).check();
+ this.albums.clear();
+ for (Album album : albums) {
+ addAlbum(album);
+ }
+ }
+
+ /**
+ * Removes an album from this Sone.
+ *
+ * @param album
+ * The album to remove
+ */
+ public void removeAlbum(Album album) {
+ Validation.begin().isNotNull("Album", album).check().isEqual("Album Owner", album.getSone(), this).check();
+ albums.remove(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
+ * <code>null</code> if the album did not change its place
+ */
+ public Album moveAlbumUp(Album album) {
+ Validation.begin().isNotNull("Album", album).check().isEqual("Album Owner", album.getSone(), this).isNull("Album Parent", album.getParent()).check();
+ int oldIndex = albums.indexOf(album);
+ if (oldIndex <= 0) {
+ return null;
+ }
+ albums.remove(oldIndex);
+ albums.add(oldIndex - 1, album);
+ return albums.get(oldIndex);
+ }
+
+ /**
+ * 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
+ * <code>null</code> if the album did not change its place
+ */
+ public Album moveAlbumDown(Album album) {
+ Validation.begin().isNotNull("Album", album).check().isEqual("Album Owner", album.getSone(), this).isNull("Album Parent", album.getParent()).check();
+ int oldIndex = albums.indexOf(album);
+ if ((oldIndex < 0) || (oldIndex >= (albums.size() - 1))) {
+ return null;
}
+ albums.remove(oldIndex);
+ albums.add(oldIndex + 1, album);
+ return albums.get(oldIndex);
+ }
+
+ /**
+ * Returns Sone-specific options.
+ *
+ * @return The options of this Sone
+ */
+ public Options getOptions() {
+ return options;
}
//
- // PRIVATE METHODS
+ // FINGERPRINTABLE METHODS
//
/**
- * Updates the editions of the request URI and the insert URI (if latter is
- * not {@code null}) with the greater edition of either one.
+ * {@inheritDoc}
*/
- private void updateEditions() {
- long requestEdition = 0;
- if (requestUri != null) {
- requestEdition = requestUri.getEdition();
+ @Override
+ public synchronized String getFingerprint() {
+ StringBuilder fingerprint = new StringBuilder();
+ fingerprint.append(profile.getFingerprint());
+
+ fingerprint.append("Posts(");
+ for (Post post : getPosts()) {
+ fingerprint.append("Post(").append(post.getId()).append(')');
+ }
+ fingerprint.append(")");
+
+ List<PostReply> replies = new ArrayList<PostReply>(getReplies());
+ Collections.sort(replies, Reply.TIME_COMPARATOR);
+ fingerprint.append("Replies(");
+ for (PostReply reply : replies) {
+ fingerprint.append("Reply(").append(reply.getId()).append(')');
}
- long insertEdition = 0;
- if (insertUri != null) {
- insertEdition = insertUri.getEdition();
+ fingerprint.append(')');
+
+ List<String> likedPostIds = new ArrayList<String>(getLikedPostIds());
+ Collections.sort(likedPostIds);
+ fingerprint.append("LikedPosts(");
+ for (String likedPostId : likedPostIds) {
+ fingerprint.append("Post(").append(likedPostId).append(')');
+ }
+ fingerprint.append(')');
+
+ List<String> likedReplyIds = new ArrayList<String>(getLikedReplyIds());
+ Collections.sort(likedReplyIds);
+ fingerprint.append("LikedReplies(");
+ for (String likedReplyId : likedReplyIds) {
+ fingerprint.append("Reply(").append(likedReplyId).append(')');
}
- updateUris(Math.max(requestEdition, insertEdition));
+ fingerprint.append(')');
+
+ fingerprint.append("Albums(");
+ for (Album album : albums) {
+ fingerprint.append(album.getFingerprint());
+ }
+ fingerprint.append(')');
+
+ return fingerprint.toString();
+ }
+
+ //
+ // INTERFACE Comparable<Sone>
+ //
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public int compareTo(Sone sone) {
+ return NICE_NAME_COMPARATOR.compare(this, sone);
}
//
*/
@Override
public String toString() {
- return getClass().getName() + "[id=" + id + ",name=" + name + ",requestUri=" + requestUri + ",insertUri=" + insertUri + ",friends(" + friendSones.size() + "),posts(" + posts.size() + "),replies(" + replies.size() + ")]";
+ return getClass().getName() + "[identity=" + identity + ",requestUri=" + requestUri + ",insertUri(" + String.valueOf(insertUri).length() + "),friends(" + friendSones.size() + "),posts(" + posts.size() + "),replies(" + replies.size() + ")]";
}
}
projects / Sone.git / blobdiff