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>();
57 * The name of the Sone
59 * The request URI of the Sone
61 public Sone(UUID id, String name, FreenetURI requestUri) {
62 this(id, name, requestUri, null);
71 * The name of the Sone
73 * The request URI of the Sone
75 * The insert URI of the Sone
77 public Sone(UUID id, String name, FreenetURI requestUri, FreenetURI insertUri) {
80 this.requestUri = requestUri;
81 this.insertUri = insertUri;
89 * Returns the ID of this Sone.
91 * @return The ID of this Sone
93 public String getId() {
98 * Returns the name of this Sone.
100 * @return The name of this Sone
102 public String getName() {
107 * Returns the request URI of this Sone.
109 * @return The request URI of this Sone
111 public FreenetURI getRequestUri() {
116 * Returns the insert URI of this Sone.
118 * @return The insert URI of this Sone
120 public FreenetURI getInsertUri() {
125 * Returns all friend Sones of this Sone.
127 * @return The friend Sones of this Sone
129 public Set<Sone> getFriendSones() {
130 return Collections.unmodifiableSet(friendSones);
134 * Returns whether this Sone has the given Sone as a friend Sone.
137 * The friend Sone to check for
138 * @return {@code true} if this Sone has the given Sone as a friend,
139 * {@code false} otherwise
141 public boolean hasFriendSone(Sone friendSone) {
142 return friendSones.contains(friendSone);
146 * Adds the given Sone as a friend Sone.
149 * The friend Sone to add
150 * @return This Sone (for method chaining)
152 public Sone addFriendSone(Sone friendSone) {
153 friendSones.add(friendSone);
158 * Removes the given Sone as a friend Sone.
161 * The friend Sone to remove
162 * @return This Sone (for method chaining)
164 public Sone removeFriendSone(Sone friendSone) {
165 friendSones.remove(friendSone);
177 public int hashCode() {
178 return id.hashCode();