Make profile fields immutable.
[Sone.git] / src / main / java / net / pterodactylus / sone / data / Profile.java
index 4b4e0f4..3e446fd 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Sone - Profile.java - Copyright © 2010–2012 David Roden
+ * Sone - Profile.java - Copyright © 2010–2013 David Roden
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
 
 package net.pterodactylus.sone.data;
 
+import static com.google.common.base.Optional.fromNullable;
 import static com.google.common.base.Preconditions.checkArgument;
 import static com.google.common.base.Preconditions.checkNotNull;
 import static com.google.common.base.Preconditions.checkState;
+import static java.util.UUID.randomUUID;
 
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
-import java.util.UUID;
+
+import com.google.common.base.Optional;
+import com.google.common.hash.Hasher;
+import com.google.common.hash.Hashing;
 
 /**
  * A profile stores personal information about a {@link Sone}. All information
@@ -37,23 +42,8 @@ public class Profile implements Fingerprintable {
        /** The Sone this profile belongs to. */
        private final Sone sone;
 
-       /** The first name. */
-       private volatile String firstName;
-
-       /** The middle name(s). */
-       private volatile String middleName;
-
-       /** The last name. */
-       private volatile String lastName;
-
-       /** The day of the birth date. */
-       private volatile Integer birthDay;
-
-       /** The month of the birth date. */
-       private volatile Integer birthMonth;
-
-       /** The year of the birth date. */
-       private volatile Integer birthYear;
+       private volatile Name name = new Name();
+       private volatile BirthDate birthDate = new BirthDate();
 
        /** The ID of the avatar image. */
        private volatile String avatar;
@@ -79,12 +69,8 @@ public class Profile implements Fingerprintable {
         */
        public Profile(Profile profile) {
                this.sone = profile.sone;
-               this.firstName = profile.firstName;
-               this.middleName = profile.middleName;
-               this.lastName = profile.lastName;
-               this.birthDay = profile.birthDay;
-               this.birthMonth = profile.birthMonth;
-               this.birthYear = profile.birthYear;
+               this.name = profile.name;
+               this.birthDate = profile.birthDate;
                this.avatar = profile.avatar;
                this.fields.addAll(profile.fields);
        }
@@ -108,19 +94,7 @@ public class Profile implements Fingerprintable {
         * @return The first name
         */
        public String getFirstName() {
-               return firstName;
-       }
-
-       /**
-        * Sets the first name.
-        *
-        * @param firstName
-        *            The first name to set
-        * @return This profile (for method chaining)
-        */
-       public Profile setFirstName(String firstName) {
-               this.firstName = firstName;
-               return this;
+               return name.getFirst().orNull();
        }
 
        /**
@@ -129,19 +103,7 @@ public class Profile implements Fingerprintable {
         * @return The middle name
         */
        public String getMiddleName() {
-               return middleName;
-       }
-
-       /**
-        * Sets the middle name.
-        *
-        * @param middleName
-        *            The middle name to set
-        * @return This profile (for method chaining)
-        */
-       public Profile setMiddleName(String middleName) {
-               this.middleName = middleName;
-               return this;
+               return name.getMiddle().orNull();
        }
 
        /**
@@ -150,19 +112,7 @@ public class Profile implements Fingerprintable {
         * @return The last name
         */
        public String getLastName() {
-               return lastName;
-       }
-
-       /**
-        * Sets the last name.
-        *
-        * @param lastName
-        *            The last name to set
-        * @return This profile (for method chaining)
-        */
-       public Profile setLastName(String lastName) {
-               this.lastName = lastName;
-               return this;
+               return name.getLast().orNull();
        }
 
        /**
@@ -171,19 +121,7 @@ public class Profile implements Fingerprintable {
         * @return The day of the birth date (from 1 to 31)
         */
        public Integer getBirthDay() {
-               return birthDay;
-       }
-
-       /**
-        * Sets the day of the birth date.
-        *
-        * @param birthDay
-        *            The day of the birth date (from 1 to 31)
-        * @return This profile (for method chaining)
-        */
-       public Profile setBirthDay(Integer birthDay) {
-               this.birthDay = birthDay;
-               return this;
+               return birthDate.getDay().orNull();
        }
 
        /**
@@ -192,19 +130,7 @@ public class Profile implements Fingerprintable {
         * @return The month of the birth date (from 1 to 12)
         */
        public Integer getBirthMonth() {
-               return birthMonth;
-       }
-
-       /**
-        * Sets the month of the birth date.
-        *
-        * @param birthMonth
-        *            The month of the birth date (from 1 to 12)
-        * @return This profile (for method chaining)
-        */
-       public Profile setBirthMonth(Integer birthMonth) {
-               this.birthMonth = birthMonth;
-               return this;
+               return birthDate.getMonth().orNull();
        }
 
        /**
@@ -213,7 +139,7 @@ public class Profile implements Fingerprintable {
         * @return The year of the birth date
         */
        public Integer getBirthYear() {
-               return birthYear;
+               return birthDate.getYear().orNull();
        }
 
        /**
@@ -229,30 +155,12 @@ public class Profile implements Fingerprintable {
        /**
         * Sets the avatar image.
         *
-        * @param avatar
-        *            The new avatar image, or {@code null} to not select an avatar
-        *            image.
-        * @return This Sone
-        */
-       public Profile setAvatar(Image avatar) {
-               if (avatar == null) {
-                       this.avatar = null;
-                       return this;
-               }
-               checkArgument(avatar.getSone().equals(sone), "avatar must belong to Sone");
-               this.avatar = avatar.getId();
-               return this;
-       }
-
-       /**
-        * Sets the year of the birth date.
-        *
-        * @param birthYear
-        *            The year of the birth date
-        * @return This profile (for method chaining)
+        * @param avatarId
+        *              The ID of the new avatar image
+        * @return This profile
         */
-       public Profile setBirthYear(Integer birthYear) {
-               this.birthYear = birthYear;
+       public Profile setAvatar(Optional<String> avatarId) {
+               this.avatar = avatarId.orNull();
                return this;
        }
 
@@ -325,11 +233,27 @@ public class Profile implements Fingerprintable {
                checkArgument(fieldName.length() > 0, "fieldName must not be empty");
                checkState(getFieldByName(fieldName) == null, "fieldName must be unique");
                @SuppressWarnings("synthetic-access")
-               Field field = new Field().setName(fieldName);
+               Field field = new Field(fieldName);
                fields.add(field);
                return field;
        }
 
+       public void renameField(Field field, String newName) {
+               int indexOfField = getFieldIndex(field);
+               if (indexOfField == -1) {
+                       return;
+               }
+               fields.set(indexOfField, new Field(field.getId(), newName, field.getValue()));
+       }
+
+       public void setField(Field field, String newValue) {
+               int indexOfField = getFieldIndex(field);
+               if (indexOfField == -1) {
+                       return;
+               }
+               fields.set(indexOfField, new Field(field.getId(), field.getName(), newValue));
+       }
+
        /**
         * Moves the given field up one position in the field list. The index of the
         * field to move must be greater than {@code 0} (because you obviously can
@@ -376,6 +300,72 @@ public class Profile implements Fingerprintable {
                fields.remove(field);
        }
 
+       public Modifier modify() {
+               return new Modifier() {
+                       private Optional<String> firstName = name.getFirst();
+                       private Optional<String> middleName = name.getMiddle();
+                       private Optional<String> lastName = name.getLast();
+                       private Optional<Integer> birthYear = birthDate.getYear();
+                       private Optional<Integer> birthMonth = birthDate.getMonth();
+                       private Optional<Integer> birthDay = birthDate.getDay();
+
+                       @Override
+                       public Modifier setFirstName(String firstName) {
+                               this.firstName = fromNullable(firstName);
+                               return this;
+                       }
+
+                       @Override
+                       public Modifier setMiddleName(String middleName) {
+                               this.middleName = fromNullable(middleName);
+                               return this;
+                       }
+
+                       @Override
+                       public Modifier setLastName(String lastName) {
+                               this.lastName = fromNullable(lastName);
+                               return this;
+                       }
+
+                       @Override
+                       public Modifier setBirthYear(Integer birthYear) {
+                               this.birthYear = fromNullable(birthYear);
+                               return this;
+                       }
+
+                       @Override
+                       public Modifier setBirthMonth(Integer birthMonth) {
+                               this.birthMonth = fromNullable(birthMonth);
+                               return this;
+                       }
+
+                       @Override
+                       public Modifier setBirthDay(Integer birthDay) {
+                               this.birthDay = fromNullable(birthDay);
+                               return this;
+                       }
+
+                       @Override
+                       public Profile update() {
+                               Profile.this.name = new Name(firstName, middleName, lastName);
+                               Profile.this.birthDate = new BirthDate(birthYear, birthMonth, birthDay);
+                               return Profile.this;
+                       }
+               };
+       }
+
+       public interface Modifier {
+
+               Modifier setFirstName(String firstName);
+               Modifier setMiddleName(String middleName);
+               Modifier setLastName(String lastName);
+               Modifier setBirthYear(Integer birthYear);
+               Modifier setBirthMonth(Integer birthMonth);
+               Modifier setBirthDay(Integer birthDay);
+               Profile update();
+
+       }
+
        //
        // PRIVATE METHODS
        //
@@ -401,37 +391,21 @@ public class Profile implements Fingerprintable {
         */
        @Override
        public String getFingerprint() {
-               StringBuilder fingerprint = new StringBuilder();
-               fingerprint.append("Profile(");
-               if (firstName != null) {
-                       fingerprint.append("FirstName(").append(firstName).append(')');
-               }
-               if (middleName != null) {
-                       fingerprint.append("MiddleName(").append(middleName).append(')');
-               }
-               if (lastName != null) {
-                       fingerprint.append("LastName(").append(lastName).append(')');
-               }
-               if (birthDay != null) {
-                       fingerprint.append("BirthDay(").append(birthDay).append(')');
-               }
-               if (birthMonth != null) {
-                       fingerprint.append("BirthMonth(").append(birthMonth).append(')');
-               }
-               if (birthYear != null) {
-                       fingerprint.append("BirthYear(").append(birthYear).append(')');
-               }
+               Hasher hash = Hashing.sha256().newHasher();
+               hash.putString("Profile(");
+               hash.putString(name.getFingerprint());
+               hash.putString(birthDate.getFingerprint());
                if (avatar != null) {
-                       fingerprint.append("Avatar(").append(avatar).append(')');
+                       hash.putString("Avatar(").putString(avatar).putString(")");
                }
-               fingerprint.append("ContactInformation(");
+               hash.putString("ContactInformation(");
                for (Field field : fields) {
-                       fingerprint.append(field.getName()).append('(').append(field.getValue()).append(')');
+                       hash.putString(field.getName()).putString("(").putString(field.getValue()).putString(")");
                }
-               fingerprint.append(")");
-               fingerprint.append(")");
+               hash.putString(")");
+               hash.putString(")");
 
-               return fingerprint.toString();
+               return hash.hash().toString();
        }
 
        /**
@@ -439,98 +413,38 @@ public class Profile implements Fingerprintable {
         *
         * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
         */
-       public class Field {
+       public static class Field {
 
-               /** The ID of the field. */
                private final String id;
+               private final String name;
+               private final String value;
 
-               /** The name of the field. */
-               private String name;
-
-               /** The value of the field. */
-               private String value;
+               public Field(String name) {
+                       this(name, null);
+               }
 
-               /**
-                * Creates a new field with a random ID.
-                */
-               private Field() {
-                       this(UUID.randomUUID().toString());
+               public Field(String name, String value) {
+                       this(randomUUID().toString(), name, value);
                }
 
-               /**
-                * Creates a new field with the given ID.
-                *
-                * @param id
-                *            The ID of the field
-                */
-               private Field(String id) {
+               public Field(String id, String name, String value) {
                        this.id = checkNotNull(id, "id must not be null");
+                       this.name = name;
+                       this.value = value;
                }
 
-               /**
-                * Returns the ID of this field.
-                *
-                * @return The ID of this field
-                */
                public String getId() {
                        return id;
                }
 
-               /**
-                * Returns the name of this field.
-                *
-                * @return The name of this field
-                */
                public String getName() {
                        return name;
                }
 
-               /**
-                * Sets the name of this field. The name must not be {@code null} and
-                * must not match any other fields in this profile but my match the name
-                * of this field.
-                *
-                * @param name
-                *            The new name of this field
-                * @return This field
-                */
-               public Field setName(String name) {
-                       checkNotNull(name, "name must not be null");
-                       checkArgument(getFieldByName(name) == null, "name must be unique");
-                       this.name = name;
-                       return this;
-               }
-
-               /**
-                * Returns the value of this field.
-                *
-                * @return The value of this field
-                */
                public String getValue() {
                        return value;
                }
 
-               /**
-                * Sets the value of this field. While {@code null} is allowed, no
-                * guarantees are made that {@code null} values are correctly persisted
-                * across restarts of the plugin!
-                *
-                * @param value
-                *            The new value of this field
-                * @return This field
-                */
-               public Field setValue(String value) {
-                       this.value = value;
-                       return this;
-               }
-
-               //
-               // OBJECT METHODS
-               //
-
-               /**
-                * {@inheritDoc}
-                */
                @Override
                public boolean equals(Object object) {
                        if (!(object instanceof Field)) {
@@ -540,9 +454,6 @@ public class Profile implements Fingerprintable {
                        return id.equals(field.id);
                }
 
-               /**
-                * {@inheritDoc}
-                */
                @Override
                public int hashCode() {
                        return id.hashCode();
@@ -550,4 +461,98 @@ public class Profile implements Fingerprintable {
 
        }
 
+       public static class Name implements Fingerprintable {
+
+               private final Optional<String> first;
+               private final Optional<String> middle;
+               private final Optional<String> last;
+
+               public Name() {
+                       this(Optional.<String>absent(), Optional.<String>absent(), Optional.<String>absent());
+               }
+
+               public Name(Optional<String> first, Optional<String> middle, Optional<String> last) {
+                       this.first = first;
+                       this.middle = middle;
+                       this.last = last;
+               }
+
+               public Optional<String> getFirst() {
+                       return first;
+               }
+
+               public Optional<String> getMiddle() {
+                       return middle;
+               }
+
+               public Optional<String> getLast() {
+                       return last;
+               }
+
+               @Override
+               public String getFingerprint() {
+                       Hasher hash = Hashing.sha256().newHasher();
+                       hash.putString("Name(");
+                       if (first.isPresent()) {
+                               hash.putString("First(").putString(first.get()).putString(")");
+                       }
+                       if (middle.isPresent()) {
+                               hash.putString("Middle(").putString(middle.get()).putString(")");
+                       }
+                       if (last.isPresent()) {
+                               hash.putString("Last(").putString(last.get()).putString(")");
+                       }
+                       hash.putString(")");
+                       return hash.hash().toString();
+               }
+
+       }
+
+       public static class BirthDate implements Fingerprintable {
+
+               private final Optional<Integer> year;
+               private final Optional<Integer> month;
+               private final Optional<Integer> day;
+
+               public BirthDate() {
+                       this(Optional.<Integer>absent(), Optional.<Integer>absent(), Optional.<Integer>absent());
+               }
+
+               public BirthDate(Optional<Integer> year, Optional<Integer> month, Optional<Integer> day) {
+                       this.year = year;
+                       this.month = month;
+                       this.day = day;
+               }
+
+               public Optional<Integer> getYear() {
+                       return year;
+               }
+
+               public Optional<Integer> getMonth() {
+                       return month;
+               }
+
+               public Optional<Integer> getDay() {
+                       return day;
+               }
+
+               @Override
+               public String getFingerprint() {
+                       Hasher hash = Hashing.sha256().newHasher();
+                       hash.putString("Birthdate(");
+                       if (year.isPresent()) {
+                               hash.putString("Year(").putInt(year.get()).putString(")");
+                       }
+                       if (month.isPresent()) {
+                               hash.putString("Month(").putInt(month.get()).putString(")");
+                       }
+                       if (day.isPresent()) {
+                               hash.putString("Day(").putInt(day.get()).putString(")");
+                       }
+                       hash.putString(")");
+                       return hash.hash().toString();
+               }
+
+       }
+
 }