Merge branch 'release/0.9-rc1'
[Sone.git] / src / main / java / net / pterodactylus / sone / data / Profile.java
index 8d4306d..4970cf9 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * FreenetSone - Profile.java - Copyright © 2010 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.Preconditions.checkArgument;
+import static com.google.common.base.Preconditions.checkNotNull;
+import static com.google.common.base.Preconditions.checkState;
+
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
 import java.util.UUID;
 
-import net.pterodactylus.util.validation.Validation;
+import com.google.common.hash.Hasher;
+import com.google.common.hash.Hashing;
 
 /**
  * A profile stores personal information about a {@link Sone}. All information
@@ -32,6 +37,9 @@ import net.pterodactylus.util.validation.Validation;
  */
 public class Profile implements Fingerprintable {
 
+       /** The Sone this profile belongs to. */
+       private final Sone sone;
+
        /** The first name. */
        private volatile String firstName;
 
@@ -50,14 +58,20 @@ public class Profile implements Fingerprintable {
        /** The year of the birth date. */
        private volatile Integer birthYear;
 
+       /** The ID of the avatar image. */
+       private volatile String avatar;
+
        /** Additional fields in the profile. */
        private final List<Field> fields = Collections.synchronizedList(new ArrayList<Field>());
 
        /**
         * Creates a new empty profile.
+        *
+        * @param sone
+        *            The Sone this profile belongs to
         */
-       public Profile() {
-               /* do nothing. */
+       public Profile(Sone sone) {
+               this.sone = sone;
        }
 
        /**
@@ -67,15 +81,14 @@ public class Profile implements Fingerprintable {
         *            The profile to copy
         */
        public Profile(Profile profile) {
-               if (profile == null) {
-                       return;
-               }
+               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.avatar = profile.avatar;
                this.fields.addAll(profile.fields);
        }
 
@@ -84,6 +97,15 @@ public class Profile implements Fingerprintable {
        //
 
        /**
+        * Returns the Sone this profile belongs to.
+        *
+        * @return The Sone this profile belongs to
+        */
+       public Sone getSone() {
+               return sone;
+       }
+
+       /**
         * Returns the first name.
         *
         * @return The first name
@@ -198,6 +220,34 @@ public class Profile implements Fingerprintable {
        }
 
        /**
+        * Returns the ID of the currently selected avatar image.
+        *
+        * @return The ID of the currently selected avatar image, or {@code null} if
+        *         no avatar is selected.
+        */
+       public String getAvatar() {
+               return avatar;
+       }
+
+       /**
+        * 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
@@ -238,7 +288,7 @@ public class Profile implements Fingerprintable {
         *         field with the given ID
         */
        public Field getFieldById(String fieldId) {
-               Validation.begin().isNotNull("Field ID", fieldId).check();
+               checkNotNull(fieldId, "fieldId must not be null");
                for (Field field : fields) {
                        if (field.getId().equals(fieldId)) {
                                return field;
@@ -274,9 +324,15 @@ public class Profile implements Fingerprintable {
         *             if the name is not valid
         */
        public Field addField(String fieldName) throws IllegalArgumentException {
-               Validation.begin().isNotNull("Field Name", fieldName).check().isGreater("Field Name Length", fieldName.length(), 0).isNull("Field Name Unique", getFieldByName(fieldName)).check();
+               checkNotNull(fieldName, "fieldName must not be null");
+               if (fieldName.length() == 0) {
+                       throw new EmptyFieldName();
+               }
+               if (getFieldByName(fieldName) != null) {
+                       throw new DuplicateField();
+               }
                @SuppressWarnings("synthetic-access")
-               Field field = new Field().setName(fieldName);
+               Field field = new Field().setName(fieldName).setValue("");
                fields.add(field);
                return field;
        }
@@ -290,7 +346,9 @@ public class Profile implements Fingerprintable {
         *            The field to move up
         */
        public void moveFieldUp(Field field) {
-               Validation.begin().isNotNull("Field", field).check().is("Field Existing", hasField(field)).isGreater("Field Index", getFieldIndex(field), 0).check();
+               checkNotNull(field, "field must not be null");
+               checkArgument(hasField(field), "field must belong to this profile");
+               checkArgument(getFieldIndex(field) > 0, "field index must be > 0");
                int fieldIndex = getFieldIndex(field);
                fields.remove(field);
                fields.add(fieldIndex - 1, field);
@@ -305,7 +363,9 @@ public class Profile implements Fingerprintable {
         *            The field to move down
         */
        public void moveFieldDown(Field field) {
-               Validation.begin().isNotNull("Field", field).check().is("Field Existing", hasField(field)).isLess("Field Index", getFieldIndex(field), fields.size() - 1).check();
+               checkNotNull(field, "field must not be null");
+               checkArgument(hasField(field), "field must belong to this profile");
+               checkArgument(getFieldIndex(field) < fields.size() - 1, "field index must be < " + (fields.size() - 1));
                int fieldIndex = getFieldIndex(field);
                fields.remove(field);
                fields.add(fieldIndex + 1, field);
@@ -318,7 +378,8 @@ public class Profile implements Fingerprintable {
         *            The field to remove
         */
        public void removeField(Field field) {
-               Validation.begin().isNotNull("Field", field).check().is("Field Existing", hasField(field)).check();
+               checkNotNull(field, "field must not be null");
+               checkArgument(hasField(field), "field must belong to this profile");
                fields.remove(field);
        }
 
@@ -347,34 +408,37 @@ public class Profile implements Fingerprintable {
         */
        @Override
        public String getFingerprint() {
-               StringBuilder fingerprint = new StringBuilder();
-               fingerprint.append("Profile(");
+               Hasher hash = Hashing.sha256().newHasher();
+               hash.putString("Profile(");
                if (firstName != null) {
-                       fingerprint.append("FirstName(").append(firstName).append(')');
+                       hash.putString("FirstName(").putString(firstName).putString(")");
                }
                if (middleName != null) {
-                       fingerprint.append("MiddleName(").append(middleName).append(')');
+                       hash.putString("MiddleName(").putString(middleName).putString(")");
                }
                if (lastName != null) {
-                       fingerprint.append("LastName(").append(lastName).append(')');
+                       hash.putString("LastName(").putString(lastName).putString(")");
                }
                if (birthDay != null) {
-                       fingerprint.append("BirthDay(").append(birthDay).append(')');
+                       hash.putString("BirthDay(").putInt(birthDay).putString(")");
                }
                if (birthMonth != null) {
-                       fingerprint.append("BirthMonth(").append(birthMonth).append(')');
+                       hash.putString("BirthMonth(").putInt(birthMonth).putString(")");
                }
                if (birthYear != null) {
-                       fingerprint.append("BirthYear(").append(birthYear).append(')');
+                       hash.putString("BirthYear(").putInt(birthYear).putString(")");
                }
-               fingerprint.append("ContactInformation(");
+               if (avatar != null) {
+                       hash.putString("Avatar(").putString(avatar).putString(")");
+               }
+               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();
        }
 
        /**
@@ -407,8 +471,7 @@ public class Profile implements Fingerprintable {
                 *            The ID of the field
                 */
                private Field(String id) {
-                       Validation.begin().isNotNull("Field ID", id).check();
-                       this.id = id;
+                       this.id = checkNotNull(id, "id must not be null");
                }
 
                /**
@@ -439,7 +502,8 @@ public class Profile implements Fingerprintable {
                 * @return This field
                 */
                public Field setName(String name) {
-                       Validation.begin().isNotNull("Field Name", name).check().is("Field Unique", (getFieldByName(name) == null) || equals(getFieldByName(name))).check();
+                       checkNotNull(name, "name must not be null");
+                       checkArgument(getFieldByName(name) == null, "name must be unique");
                        this.name = name;
                        return this;
                }
@@ -493,4 +557,18 @@ public class Profile implements Fingerprintable {
 
        }
 
+       /**
+        * Exception that signals the addition of a field with an empty name.
+        *
+        * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
+        */
+       public static class EmptyFieldName extends IllegalArgumentException { }
+
+       /**
+        * Exception that signals the addition of a field that already exists.
+        *
+        * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
+        */
+       public static class DuplicateField extends IllegalArgumentException { }
+
 }