package net.pterodactylus.sone.data;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
+import java.util.UUID;
+
import freenet.keys.FreenetURI;
/**
* A Sone defines everything about a user: the {@link User} itself, her profile,
* her status updates.
+ * <p>
+ * Operations that modify the Sone need to synchronize on the Sone in question.
*
* @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
*/
public class Sone {
+ /** A GUID for this Sone. */
+ private final UUID id;
+
+ /** The name of this Sone. */
+ private final String name;
+
/** The URI under which the Sone is stored in Freenet. */
private final FreenetURI requestUri;
/* This will be null for remote Sones! */
private final FreenetURI insertUri;
+ /** The profile of this Sone. */
+ private Profile profile;
+
+ /** All friend Sones. */
+ private final Set<Sone> friendSones = new HashSet<Sone>();
+
+ /** All posts. */
+ private final List<Post> posts = new ArrayList<Post>();
+
+ /** Modification count. */
+ private volatile long modificationCounter = 0;
+
/**
* 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
*/
- public Sone(FreenetURI requestUri) {
- this(requestUri, null);
+ public Sone(UUID id, String name, FreenetURI requestUri) {
+ this(id, name, requestUri, null);
}
/**
* 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
*/
- public Sone(FreenetURI requestUri, FreenetURI insertUri) {
+ public Sone(UUID id, String name, FreenetURI requestUri, FreenetURI insertUri) {
+ this.id = id;
+ this.name = name;
this.requestUri = requestUri;
this.insertUri = insertUri;
}
//
/**
+ * Returns the ID of this Sone.
+ *
+ * @return The ID of this Sone
+ */
+ public String getId() {
+ return id.toString();
+ }
+
+ /**
+ * Returns the name of this Sone.
+ *
+ * @return The name of this Sone
+ */
+ public String getName() {
+ return name;
+ }
+
+ /**
* Returns the request URI of this Sone.
*
* @return The request URI of this Sone
*/
- public FreenetURI requestUri() {
+ public FreenetURI getRequestUri() {
return requestUri;
}
*
* @return The insert URI of this Sone
*/
- public FreenetURI insertUri() {
+ public FreenetURI getInsertUri() {
return insertUri;
}
+ /**
+ * 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() {
+ return new Profile(profile);
+ }
+
+ /**
+ * 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 synchronized void setProfile(Profile profile) {
+ this.profile = new Profile(profile);
+ modificationCounter++;
+ }
+
+ /**
+ * Returns all friend Sones of this Sone.
+ *
+ * @return The friend Sones of this Sone
+ */
+ public Set<Sone> getFriendSones() {
+ return Collections.unmodifiableSet(friendSones);
+ }
+
+ /**
+ * 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
+ */
+ public boolean hasFriendSone(Sone friendSone) {
+ return friendSones.contains(friendSone);
+ }
+
+ /**
+ * Adds the given Sone as a friend Sone.
+ *
+ * @param friendSone
+ * The friend Sone to add
+ * @return This Sone (for method chaining)
+ */
+ public synchronized Sone addFriendSone(Sone friendSone) {
+ if (friendSones.add(friendSone)) {
+ modificationCounter++;
+ }
+ return this;
+ }
+
+ /**
+ * Removes the given Sone as a friend Sone.
+ *
+ * @param friendSone
+ * The friend Sone to remove
+ * @return This Sone (for method chaining)
+ */
+ public synchronized Sone removeFriendSone(Sone friendSone) {
+ if (friendSones.remove(friendSone)) {
+ modificationCounter++;
+ }
+ return this;
+ }
+
+ /**
+ * Returns the list of posts of this Sone.
+ *
+ * @return All posts of this Sone
+ */
+ public List<Post> getPosts() {
+ return Collections.unmodifiableList(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
+ */
+ public synchronized void addPost(Post post) {
+ if (post.getSone().equals(this) && posts.add(post)) {
+ modificationCounter++;
+ }
+ }
+
+ /**
+ * Removes the given post from this Sone.
+ *
+ * @param post
+ * The post to remove
+ */
+ public synchronized void removePost(Post post) {
+ if (post.getSone().equals(this) && posts.remove(post)) {
+ modificationCounter++;
+ }
+ }
+
+ /**
+ * Returns the modification counter.
+ *
+ * @return The modification counter
+ */
+ public synchronized long getModificationCounter() {
+ return modificationCounter;
+ }
+
+ /**
+ * Sets the modification counter.
+ *
+ * @param modificationCounter
+ * The new modification counter
+ */
+ public synchronized void setModificationCounter(long modificationCounter) {
+ this.modificationCounter = modificationCounter;
+ }
+
+ //
+ // OBJECT METHODS
+ //
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public int hashCode() {
+ return id.hashCode();
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public boolean equals(Object object) {
+ if (!(object instanceof Sone)) {
+ return false;
+ }
+ return ((Sone) object).id.equals(id);
+ }
+
}
projects / Sone.git / blobdiff