2 * Sone - Profile.java - Copyright © 2010–2013 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 static com.google.common.base.Optional.fromNullable;
21 import static com.google.common.base.Preconditions.checkArgument;
22 import static com.google.common.base.Preconditions.checkNotNull;
23 import static com.google.common.base.Preconditions.checkState;
24 import static java.util.UUID.randomUUID;
26 import java.util.ArrayList;
27 import java.util.Collections;
28 import java.util.List;
30 import com.google.common.base.Optional;
31 import com.google.common.hash.Hasher;
32 import com.google.common.hash.Hashing;
35 * A profile stores personal information about a {@link Sone}. All information
36 * is optional and can be {@code null}.
38 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
40 public class Profile implements Fingerprintable {
42 /** The Sone this profile belongs to. */
43 private final Sone sone;
45 private volatile Name name = new Name();
46 private volatile BirthDate birthDate = new BirthDate();
48 /** The ID of the avatar image. */
49 private volatile String avatar;
51 /** Additional fields in the profile. */
52 private final List<Field> fields = Collections.synchronizedList(new ArrayList<Field>());
55 * Creates a new empty profile.
58 * The Sone this profile belongs to
60 public Profile(Sone sone) {
65 * Creates a copy of a profile.
70 public Profile(Profile profile) {
71 this.sone = profile.sone;
72 this.name = profile.name;
73 this.birthDate = profile.birthDate;
74 this.avatar = profile.avatar;
75 this.fields.addAll(profile.fields);
83 * Returns the Sone this profile belongs to.
85 * @return The Sone this profile belongs to
87 public Sone getSone() {
92 * Returns the first name.
94 * @return The first name
96 public String getFirstName() {
97 return name.getFirst().orNull();
101 * Returns the middle name(s).
103 * @return The middle name
105 public String getMiddleName() {
106 return name.getMiddle().orNull();
110 * Returns the last name.
112 * @return The last name
114 public String getLastName() {
115 return name.getLast().orNull();
119 * Returns the day of the birth date.
121 * @return The day of the birth date (from 1 to 31)
123 public Integer getBirthDay() {
124 return birthDate.getDay().orNull();
128 * Returns the month of the birth date.
130 * @return The month of the birth date (from 1 to 12)
132 public Integer getBirthMonth() {
133 return birthDate.getMonth().orNull();
137 * Returns the year of the birth date.
139 * @return The year of the birth date
141 public Integer getBirthYear() {
142 return birthDate.getYear().orNull();
146 * Returns the ID of the currently selected avatar image.
148 * @return The ID of the currently selected avatar image, or {@code null} if
149 * no avatar is selected.
151 public String getAvatar() {
156 * Sets the avatar image.
159 * The ID of the new avatar image
160 * @return This profile
162 public Profile setAvatar(Optional<String> avatarId) {
163 this.avatar = avatarId.orNull();
168 * Returns the fields of this profile.
170 * @return The fields of this profile
172 public List<Field> getFields() {
173 return new ArrayList<Field>(fields);
177 * Returns whether this profile contains the given field.
180 * The field to check for
181 * @return {@code true} if this profile contains the field, false otherwise
183 public boolean hasField(Field field) {
184 return fields.contains(field);
188 * Returns the field with the given ID.
191 * The ID of the field to get
192 * @return The field, or {@code null} if this profile does not contain a
193 * field with the given ID
195 public Field getFieldById(String fieldId) {
196 checkNotNull(fieldId, "fieldId must not be null");
197 for (Field field : fields) {
198 if (field.getId().equals(fieldId)) {
206 * Returns the field with the given name.
209 * The name of the field to get
210 * @return The field, or {@code null} if this profile does not contain a
211 * field with the given name
213 public Field getFieldByName(String fieldName) {
214 for (Field field : fields) {
215 if (field.getName().equals(fieldName)) {
223 * Appends a new field to the list of fields.
226 * The name of the new field
227 * @return The new field
228 * @throws IllegalArgumentException
229 * if the name is not valid
231 public Field addField(String fieldName) throws IllegalArgumentException {
232 checkNotNull(fieldName, "fieldName must not be null");
233 checkArgument(fieldName.length() > 0, "fieldName must not be empty");
234 checkState(getFieldByName(fieldName) == null, "fieldName must be unique");
235 @SuppressWarnings("synthetic-access")
236 Field field = new Field(fieldName);
241 public void renameField(Field field, String newName) {
242 int indexOfField = getFieldIndex(field);
243 if (indexOfField == -1) {
246 fields.set(indexOfField, new Field(field.getId(), newName, field.getValue()));
249 public void setField(Field field, String newValue) {
250 int indexOfField = getFieldIndex(field);
251 if (indexOfField == -1) {
254 fields.set(indexOfField, new Field(field.getId(), field.getName(), newValue));
258 * Moves the given field up one position in the field list. The index of the
259 * field to move must be greater than {@code 0} (because you obviously can
260 * not move the first field further up).
263 * The field to move up
265 public void moveFieldUp(Field field) {
266 checkNotNull(field, "field must not be null");
267 checkArgument(hasField(field), "field must belong to this profile");
268 checkArgument(getFieldIndex(field) > 0, "field index must be > 0");
269 int fieldIndex = getFieldIndex(field);
270 fields.remove(field);
271 fields.add(fieldIndex - 1, field);
275 * Moves the given field down one position in the field list. The index of
276 * the field to move must be less than the index of the last field (because
277 * you obviously can not move the last field further down).
280 * The field to move down
282 public void moveFieldDown(Field field) {
283 checkNotNull(field, "field must not be null");
284 checkArgument(hasField(field), "field must belong to this profile");
285 checkArgument(getFieldIndex(field) < fields.size() - 1, "field index must be < " + (fields.size() - 1));
286 int fieldIndex = getFieldIndex(field);
287 fields.remove(field);
288 fields.add(fieldIndex + 1, field);
292 * Removes the given field.
295 * The field to remove
297 public void removeField(Field field) {
298 checkNotNull(field, "field must not be null");
299 checkArgument(hasField(field), "field must belong to this profile");
300 fields.remove(field);
303 public Modifier modify() {
304 return new Modifier() {
305 private Optional<String> firstName = name.getFirst();
306 private Optional<String> middleName = name.getMiddle();
307 private Optional<String> lastName = name.getLast();
308 private Optional<Integer> birthYear = birthDate.getYear();
309 private Optional<Integer> birthMonth = birthDate.getMonth();
310 private Optional<Integer> birthDay = birthDate.getDay();
313 public Modifier setFirstName(String firstName) {
314 this.firstName = fromNullable(firstName);
319 public Modifier setMiddleName(String middleName) {
320 this.middleName = fromNullable(middleName);
325 public Modifier setLastName(String lastName) {
326 this.lastName = fromNullable(lastName);
331 public Modifier setBirthYear(Integer birthYear) {
332 this.birthYear = fromNullable(birthYear);
337 public Modifier setBirthMonth(Integer birthMonth) {
338 this.birthMonth = fromNullable(birthMonth);
343 public Modifier setBirthDay(Integer birthDay) {
344 this.birthDay = fromNullable(birthDay);
349 public Profile update() {
350 Profile.this.name = new Name(firstName, middleName, lastName);
351 Profile.this.birthDate = new BirthDate(birthYear, birthMonth, birthDay);
357 public interface Modifier {
359 Modifier setFirstName(String firstName);
360 Modifier setMiddleName(String middleName);
361 Modifier setLastName(String lastName);
362 Modifier setBirthYear(Integer birthYear);
363 Modifier setBirthMonth(Integer birthMonth);
364 Modifier setBirthDay(Integer birthDay);
374 * Returns the index of the field with the given name.
377 * The name of the field
378 * @return The index of the field, or {@code -1} if there is no field with
381 private int getFieldIndex(Field field) {
382 return fields.indexOf(field);
386 // INTERFACE Fingerprintable
393 public String getFingerprint() {
394 Hasher hash = Hashing.sha256().newHasher();
395 hash.putString("Profile(");
396 hash.putString(name.getFingerprint());
397 hash.putString(birthDate.getFingerprint());
398 if (avatar != null) {
399 hash.putString("Avatar(").putString(avatar).putString(")");
401 hash.putString("ContactInformation(");
402 for (Field field : fields) {
403 hash.putString(field.getName()).putString("(").putString(field.getValue()).putString(")");
408 return hash.hash().toString();
412 * Container for a profile field.
414 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
416 public static class Field {
418 private final String id;
419 private final String name;
420 private final String value;
422 public Field(String name) {
426 public Field(String name, String value) {
427 this(randomUUID().toString(), name, value);
430 public Field(String id, String name, String value) {
431 this.id = checkNotNull(id, "id must not be null");
436 public String getId() {
440 public String getName() {
444 public String getValue() {
449 public boolean equals(Object object) {
450 if (!(object instanceof Field)) {
453 Field field = (Field) object;
454 return id.equals(field.id);
458 public int hashCode() {
459 return id.hashCode();
464 public static class Name implements Fingerprintable {
466 private final Optional<String> first;
467 private final Optional<String> middle;
468 private final Optional<String> last;
471 this(Optional.<String>absent(), Optional.<String>absent(), Optional.<String>absent());
474 public Name(Optional<String> first, Optional<String> middle, Optional<String> last) {
476 this.middle = middle;
480 public Optional<String> getFirst() {
484 public Optional<String> getMiddle() {
488 public Optional<String> getLast() {
493 public String getFingerprint() {
494 Hasher hash = Hashing.sha256().newHasher();
495 hash.putString("Name(");
496 if (first.isPresent()) {
497 hash.putString("First(").putString(first.get()).putString(")");
499 if (middle.isPresent()) {
500 hash.putString("Middle(").putString(middle.get()).putString(")");
502 if (last.isPresent()) {
503 hash.putString("Last(").putString(last.get()).putString(")");
506 return hash.hash().toString();
511 public static class BirthDate implements Fingerprintable {
513 private final Optional<Integer> year;
514 private final Optional<Integer> month;
515 private final Optional<Integer> day;
518 this(Optional.<Integer>absent(), Optional.<Integer>absent(), Optional.<Integer>absent());
521 public BirthDate(Optional<Integer> year, Optional<Integer> month, Optional<Integer> day) {
527 public Optional<Integer> getYear() {
531 public Optional<Integer> getMonth() {
535 public Optional<Integer> getDay() {
540 public String getFingerprint() {
541 Hasher hash = Hashing.sha256().newHasher();
542 hash.putString("Birthdate(");
543 if (year.isPresent()) {
544 hash.putString("Year(").putInt(year.get()).putString(")");
546 if (month.isPresent()) {
547 hash.putString("Month(").putInt(month.get()).putString(")");
549 if (day.isPresent()) {
550 hash.putString("Day(").putInt(day.get()).putString(")");
553 return hash.hash().toString();