X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fnet%2Fpterodactylus%2Fsone%2Fdata%2FProfile.java;h=61cf2911f372e93aa33b329ee9a81e14353689af;hb=0a4b6fc252003c71f4bdef09560e87982838d9c8;hp=6b44d10eac29733242f4b24239e906f8ac1e04c6;hpb=c5e641893a2656ebf2c2c8c369fe75eaf3061b52;p=Sone.git

diff --git a/src/main/java/net/pterodactylus/sone/data/Profile.java b/src/main/java/net/pterodactylus/sone/data/Profile.java
index 6b44d10..61cf291 100644
--- a/src/main/java/net/pterodactylus/sone/data/Profile.java
+++ b/src/main/java/net/pterodactylus/sone/data/Profile.java
@@ -1,5 +1,5 @@
 /*
- * Sone - 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
@@ -17,12 +17,22 @@
 
 package net.pterodactylus.sone.data;
 
+import static com.google.common.base.Optional.absent;
+import static com.google.common.base.Optional.fromNullable;
+import static com.google.common.base.Optional.of;
+import static com.google.common.base.Preconditions.checkArgument;
+import static com.google.common.base.Preconditions.checkNotNull;
+import static java.lang.Math.max;
+import static java.lang.Math.min;
+import static java.util.UUID.randomUUID;
+
 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.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
@@ -32,32 +42,26 @@ import net.pterodactylus.util.validation.Validation;
  */
 public class Profile implements Fingerprintable {
 
-	/** The first name. */
-	private volatile String firstName;
-
-	/** The middle name(s). */
-	private volatile String middleName;
-
-	/** The last name. */
-	private volatile String lastName;
+	/** The Sone this profile belongs to. */
+	private final Sone sone;
 
-	/** The day of the birth date. */
-	private volatile Integer birthDay;
+	private volatile Name name = new Name();
+	private volatile BirthDate birthDate = new BirthDate();
 
-	/** The month of the birth date. */
-	private volatile Integer birthMonth;
-
-	/** 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 +71,10 @@ public class Profile implements Fingerprintable {
 	 *            The profile to copy
 	 */
 	public Profile(Profile profile) {
-		if (profile == null) {
-			return;
-		}
-		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.sone = profile.sone;
+		this.name = profile.name;
+		this.birthDate = profile.birthDate;
+		this.avatar = profile.avatar;
 		this.fields.addAll(profile.fields);
 	}
 
@@ -84,244 +83,187 @@ public class Profile implements Fingerprintable {
 	//
 
 	/**
-	 * Returns the first name.
+	 * Returns the Sone this profile belongs to.
 	 *
-	 * @return The first name
+	 * @return The Sone this profile belongs to
 	 */
-	public String getFirstName() {
-		return firstName;
+	public Sone getSone() {
+		return sone;
 	}
 
-	/**
-	 * 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;
+	public String getFirstName() {
+		return name.getFirst().orNull();
 	}
 
-	/**
-	 * Returns the middle name(s).
-	 *
-	 * @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();
 	}
 
-	/**
-	 * Returns the last name.
-	 *
-	 * @return The last name
-	 */
 	public String getLastName() {
-		return lastName;
+		return name.getLast().orNull();
 	}
 
-	/**
-	 * 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;
-	}
-
-	/**
-	 * Returns the day of the birth date.
-	 *
-	 * @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();
 	}
 
-	/**
-	 * Returns the month of the birth date.
-	 *
-	 * @return The month of the birth date (from 1 to 12)
-	 */
 	public Integer getBirthMonth() {
-		return birthMonth;
+		return birthDate.getMonth().orNull();
 	}
 
-	/**
-	 * 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;
+	public Integer getBirthYear() {
+		return birthDate.getYear().orNull();
 	}
 
-	/**
-	 * Returns the year of the birth date.
-	 *
-	 * @return The year of the birth date
-	 */
-	public Integer getBirthYear() {
-		return birthYear;
+	public String getAvatar() {
+		return avatar;
 	}
 
-	/**
-	 * Sets the year of the birth date.
-	 *
-	 * @param birthYear
-	 *            The year of the birth date
-	 * @return This profile (for method chaining)
-	 */
-	public Profile setBirthYear(Integer birthYear) {
-		this.birthYear = birthYear;
+	public Profile setAvatar(Optional<String> avatarId) {
+		this.avatar = avatarId.orNull();
 		return this;
 	}
 
-	/**
-	 * Returns the fields of this profile.
-	 *
-	 * @return The fields of this profile
-	 */
 	public List<Field> getFields() {
 		return new ArrayList<Field>(fields);
 	}
 
-	/**
-	 * Returns whether this profile contains the given field.
-	 *
-	 * @param field
-	 *            The field to check for
-	 * @return {@code true} if this profile contains the field, false otherwise
-	 */
 	public boolean hasField(Field field) {
 		return fields.contains(field);
 	}
 
-	/**
-	 * Returns the field with the given ID.
-	 *
-	 * @param fieldId
-	 *            The ID of the field to get
-	 * @return The field, or {@code null} if this profile does not contain a
-	 *         field with the given ID
-	 */
-	public Field getFieldById(String fieldId) {
-		Validation.begin().isNotNull("Field ID", fieldId).check();
+	public Optional<Field> getFieldById(String fieldId) {
+		checkNotNull(fieldId, "fieldId must not be null");
 		for (Field field : fields) {
 			if (field.getId().equals(fieldId)) {
-				return field;
+				return of(field);
 			}
 		}
-		return null;
+		return absent();
 	}
 
-	/**
-	 * Returns the field with the given name.
-	 *
-	 * @param fieldName
-	 *            The name of the field to get
-	 * @return The field, or {@code null} if this profile does not contain a
-	 *         field with the given name
-	 */
-	public Field getFieldByName(String fieldName) {
+	public Optional<Field> getFieldByName(String fieldName) {
 		for (Field field : fields) {
 			if (field.getName().equals(fieldName)) {
-				return field;
+				return of(field);
 			}
 		}
-		return null;
+		return absent();
 	}
 
-	/**
-	 * Appends a new field to the list of fields.
-	 *
-	 * @param fieldName
-	 *            The name of the new field
-	 * @return The new field
-	 * @throws IllegalArgumentException
-	 *             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");
+		checkArgument(fieldName.length() > 0, "fieldName must not be empty");
+		checkArgument(!getFieldByName(fieldName).isPresent(), "fieldName must be unique");
 		@SuppressWarnings("synthetic-access")
-		Field field = new Field().setName(fieldName);
+		Field field = new Field(fieldName);
 		fields.add(field);
 		return field;
 	}
 
-	/**
-	 * 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
-	 * not move the first field further up).
-	 *
-	 * @param field
-	 *            The field to move up
-	 */
+	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));
+	}
+
 	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");
 		int fieldIndex = getFieldIndex(field);
 		fields.remove(field);
-		fields.add(fieldIndex - 1, field);
+		fields.add(max(fieldIndex - 1, 0), field);
 	}
 
-	/**
-	 * Moves the given field down one position in the field list. The index of
-	 * the field to move must be less than the index of the last field (because
-	 * you obviously can not move the last field further down).
-	 *
-	 * @param field
-	 *            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");
 		int fieldIndex = getFieldIndex(field);
 		fields.remove(field);
-		fields.add(fieldIndex + 1, field);
+		fields.add(min(fieldIndex + 1, fields.size()), field);
 	}
 
-	/**
-	 * Removes the given field.
-	 *
-	 * @param field
-	 *            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");
 		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
 	//
@@ -342,39 +284,25 @@ public class Profile implements Fingerprintable {
 	// INTERFACE Fingerprintable
 	//
 
-	/**
-	 * {@inheritDoc}
-	 */
 	@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) {
+			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(')');
+			if (field.getValue() != null) {
+				hash.putString(field.getName()).putString("(").putString(field.getValue()).putString(")");
+			}
 		}
-		fingerprint.append(")");
-		fingerprint.append(")");
+		hash.putString(")");
+		hash.putString(")");
 
-		return fingerprint.toString();
+		return hash.hash().toString();
 	}
 
 	/**
@@ -382,98 +310,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) {
-			Validation.begin().isNotNull("Field ID", id).check();
-			this.id = 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) {
-			Validation.begin().isNotNull("Field Name", name).check().is("Field Unique", (getFieldByName(name) == null) || equals(getFieldByName(name))).check();
-			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)) {
@@ -483,9 +351,6 @@ public class Profile implements Fingerprintable {
 			return id.equals(field.id);
 		}
 
-		/**
-		 * {@inheritDoc}
-		 */
 		@Override
 		public int hashCode() {
 			return id.hashCode();
@@ -493,4 +358,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();
+		}
+
+	}
+
 }