2 * FreenetSone - Sone.java - Copyright © 2010 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 java.util.Collections;
21 import java.util.HashSet;
23 import java.util.UUID;
25 import freenet.keys.FreenetURI;
28 * A Sone defines everything about a user: the {@link User} itself, her profile,
31 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
35 /** A GUID for this Sone. */
36 private final UUID id;
38 /** The name of this Sone. */
39 private final String name;
41 /** The URI under which the Sone is stored in Freenet. */
42 private final FreenetURI requestUri;
44 /** The URI used to insert a new version of this Sone. */
45 /* This will be null for remote Sones! */
46 private final FreenetURI insertUri;
48 /** All friend Sones. */
49 private final Set<Sone> friendSones = new HashSet<Sone>();
51 /** Modification count. */
52 private volatile long modificationCounter = 0;
60 * The name of the Sone
62 * The request URI of the Sone
64 public Sone(UUID id, String name, FreenetURI requestUri) {
65 this(id, name, requestUri, null);
74 * The name of the Sone
76 * The request URI of the Sone
78 * The insert URI of the Sone
80 public Sone(UUID id, String name, FreenetURI requestUri, FreenetURI insertUri) {
83 this.requestUri = requestUri;
84 this.insertUri = insertUri;
92 * Returns the ID of this Sone.
94 * @return The ID of this Sone
96 public String getId() {
101 * Returns the name of this Sone.
103 * @return The name of this Sone
105 public String getName() {
110 * Returns the request URI of this Sone.
112 * @return The request URI of this Sone
114 public FreenetURI getRequestUri() {
119 * Returns the insert URI of this Sone.
121 * @return The insert URI of this Sone
123 public FreenetURI getInsertUri() {
128 * Returns all friend Sones of this Sone.
130 * @return The friend Sones of this Sone
132 public Set<Sone> getFriendSones() {
133 return Collections.unmodifiableSet(friendSones);
137 * Returns whether this Sone has the given Sone as a friend Sone.
140 * The friend Sone to check for
141 * @return {@code true} if this Sone has the given Sone as a friend,
142 * {@code false} otherwise
144 public boolean hasFriendSone(Sone friendSone) {
145 return friendSones.contains(friendSone);
149 * Adds the given Sone as a friend Sone.
152 * The friend Sone to add
153 * @return This Sone (for method chaining)
155 public synchronized Sone addFriendSone(Sone friendSone) {
156 if (friendSones.add(friendSone)) {
157 modificationCounter++;
163 * Removes the given Sone as a friend Sone.
166 * The friend Sone to remove
167 * @return This Sone (for method chaining)
169 public synchronized Sone removeFriendSone(Sone friendSone) {
170 if (friendSones.remove(friendSone)) {
171 modificationCounter++;
177 * Returns the modification counter.
179 * @return The modification counter
181 public synchronized long getModificationCounter() {
182 return modificationCounter;
186 * Sets the modification counter.
188 * @param modificationCounter
189 * The new modification counter
191 public synchronized void setModificationCounter(long modificationCounter) {
192 this.modificationCounter = modificationCounter;
203 public int hashCode() {
204 return id.hashCode();
211 public boolean equals(Object object) {
212 if (!(object instanceof Sone)) {
215 return ((Sone) object).id.equals(id);