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;
24 import freenet.keys.FreenetURI;
27 * A Sone defines everything about a user: the {@link User} itself, her profile,
30 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
34 /** The URI under which the Sone is stored in Freenet. */
35 private final FreenetURI requestUri;
37 /** The URI used to insert a new version of this Sone. */
38 /* This will be null for remote Sones! */
39 private final FreenetURI insertUri;
41 /** All friend Sones. */
42 private final Set<Sone> friendSones = new HashSet<Sone>();
48 * The request URI of the Sone
50 public Sone(FreenetURI requestUri) {
51 this(requestUri, null);
58 * The request URI of the Sone
60 * The insert URI of the Sone
62 public Sone(FreenetURI requestUri, FreenetURI insertUri) {
63 this.requestUri = requestUri;
64 this.insertUri = insertUri;
72 * Returns the request URI of this Sone.
74 * @return The request URI of this Sone
76 public FreenetURI requestUri() {
81 * Returns the insert URI of this Sone.
83 * @return The insert URI of this Sone
85 public FreenetURI insertUri() {
90 * Returns all friend Sones of this Sone.
92 * @return The friend Sones of this Sone
94 public Set<Sone> getFriendSones() {
95 return Collections.unmodifiableSet(friendSones);
99 * Returns whether this Sone has the given Sone as a friend Sone.
102 * The friend Sone to check for
103 * @return {@code true} if this Sone has the given Sone as a friend,
104 * {@code false} otherwise
106 public boolean hasFriendSone(Sone friendSone) {
107 return friendSones.contains(friendSone);
111 * Adds the given Sone as a friend Sone.
114 * The friend Sone to add
115 * @return This Sone (for method chaining)
117 public Sone addFriendSone(Sone friendSone) {
118 friendSones.add(friendSone);
123 * Removes the given Sone as a friend Sone.
126 * The friend Sone to remove
127 * @return This Sone (for method chaining)
129 public Sone removeFriendSone(Sone friendSone) {
130 friendSones.remove(friendSone);