X-Git-Url: https://git.pterodactylus.net/?p=Sone.git;a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fnet%2Fpterodactylus%2Fsone%2Fdata%2FProfile.java;h=c3ffe6007b411d9d026fc6a0f2d2c66917d47278;hp=6b44d10eac29733242f4b24239e906f8ac1e04c6;hb=2bacfa78f3191fd9847574a6c8b218a4882844a4;hpb=0df5e91852f737d760c5a9f54c5667309fbadcc2 diff --git a/src/main/java/net/pterodactylus/sone/data/Profile.java b/src/main/java/net/pterodactylus/sone/data/Profile.java index 6b44d10..c3ffe60 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–2016 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,21 +17,30 @@ 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 javax.annotation.Nonnull; +import javax.annotation.Nullable; + +import com.google.common.hash.Hasher; +import com.google.common.hash.Hashing; /** * A profile stores personal information about a {@link Sone}. All information * is optional and can be {@code null}. - * - * @author David ‘Bombe’ Roden */ public class Profile implements Fingerprintable { + /** The Sone this profile belongs to. */ + private final Sone sone; + /** The first name. */ private volatile String firstName; @@ -50,14 +59,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 fields = Collections.synchronizedList(new ArrayList()); /** * Creates a new empty profile. + * + * @param sone + * The Sone this profile belongs to */ - public Profile() { - /* do nothing. */ + public Profile(Sone sone) { + this.sone = sone; } /** @@ -66,16 +81,15 @@ public class Profile implements Fingerprintable { * @param profile * The profile to copy */ - public Profile(Profile profile) { - if (profile == null) { - return; - } + public Profile(@Nonnull 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.avatar = profile.avatar; this.fields.addAll(profile.fields); } @@ -84,10 +98,21 @@ public class Profile implements Fingerprintable { // /** + * Returns the Sone this profile belongs to. + * + * @return The Sone this profile belongs to + */ + @Nonnull + public Sone getSone() { + return sone; + } + + /** * Returns the first name. * * @return The first name */ + @Nullable public String getFirstName() { return firstName; } @@ -99,7 +124,8 @@ public class Profile implements Fingerprintable { * The first name to set * @return This profile (for method chaining) */ - public Profile setFirstName(String firstName) { + @Nonnull + public Profile setFirstName(@Nullable String firstName) { this.firstName = firstName; return this; } @@ -109,6 +135,7 @@ public class Profile implements Fingerprintable { * * @return The middle name */ + @Nullable public String getMiddleName() { return middleName; } @@ -120,7 +147,8 @@ public class Profile implements Fingerprintable { * The middle name to set * @return This profile (for method chaining) */ - public Profile setMiddleName(String middleName) { + @Nonnull + public Profile setMiddleName(@Nullable String middleName) { this.middleName = middleName; return this; } @@ -130,6 +158,7 @@ public class Profile implements Fingerprintable { * * @return The last name */ + @Nullable public String getLastName() { return lastName; } @@ -141,7 +170,8 @@ public class Profile implements Fingerprintable { * The last name to set * @return This profile (for method chaining) */ - public Profile setLastName(String lastName) { + @Nonnull + public Profile setLastName(@Nullable String lastName) { this.lastName = lastName; return this; } @@ -151,6 +181,7 @@ public class Profile implements Fingerprintable { * * @return The day of the birth date (from 1 to 31) */ + @Nullable public Integer getBirthDay() { return birthDay; } @@ -162,7 +193,8 @@ public class Profile implements Fingerprintable { * The day of the birth date (from 1 to 31) * @return This profile (for method chaining) */ - public Profile setBirthDay(Integer birthDay) { + @Nonnull + public Profile setBirthDay(@Nullable Integer birthDay) { this.birthDay = birthDay; return this; } @@ -172,6 +204,7 @@ public class Profile implements Fingerprintable { * * @return The month of the birth date (from 1 to 12) */ + @Nullable public Integer getBirthMonth() { return birthMonth; } @@ -183,7 +216,8 @@ public class Profile implements Fingerprintable { * The month of the birth date (from 1 to 12) * @return This profile (for method chaining) */ - public Profile setBirthMonth(Integer birthMonth) { + @Nonnull + public Profile setBirthMonth(@Nullable Integer birthMonth) { this.birthMonth = birthMonth; return this; } @@ -193,18 +227,50 @@ public class Profile implements Fingerprintable { * * @return The year of the birth date */ + @Nullable public Integer getBirthYear() { return birthYear; } /** + * 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. + */ + @Nullable + 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 + */ + @Nonnull + public Profile setAvatar(@Nullable 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) */ - public Profile setBirthYear(Integer birthYear) { + @Nonnull + public Profile setBirthYear(@Nullable Integer birthYear) { this.birthYear = birthYear; return this; } @@ -214,8 +280,9 @@ public class Profile implements Fingerprintable { * * @return The fields of this profile */ + @Nonnull public List getFields() { - return new ArrayList(fields); + return new ArrayList<>(fields); } /** @@ -225,7 +292,7 @@ public class Profile implements Fingerprintable { * The field to check for * @return {@code true} if this profile contains the field, false otherwise */ - public boolean hasField(Field field) { + public boolean hasField(@Nonnull Field field) { return fields.contains(field); } @@ -237,8 +304,9 @@ public class Profile implements Fingerprintable { * @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(); + @Nullable + public Field getFieldById(@Nonnull String fieldId) { + checkNotNull(fieldId, "fieldId must not be null"); for (Field field : fields) { if (field.getId().equals(fieldId)) { return field; @@ -255,7 +323,8 @@ public class Profile implements Fingerprintable { * @return The field, or {@code null} if this profile does not contain a * field with the given name */ - public Field getFieldByName(String fieldName) { + @Nullable + public Field getFieldByName(@Nonnull String fieldName) { for (Field field : fields) { if (field.getName().equals(fieldName)) { return field; @@ -273,10 +342,17 @@ public class Profile implements Fingerprintable { * @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(); + @Nonnull + public Field addField(@Nonnull String fieldName) throws IllegalArgumentException { + 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; } @@ -289,8 +365,10 @@ public class Profile implements Fingerprintable { * @param field * 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(); + public void moveFieldUp(@Nonnull Field field) { + 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); @@ -304,8 +382,10 @@ public class Profile implements Fingerprintable { * @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(); + public void moveFieldDown(@Nonnull Field field) { + 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); @@ -317,8 +397,9 @@ public class Profile implements Fingerprintable { * @param field * The field to remove */ - public void removeField(Field field) { - Validation.begin().isNotNull("Field", field).check().is("Field Existing", hasField(field)).check(); + public void removeField(@Nonnull Field field) { + checkNotNull(field, "field must not be null"); + checkArgument(hasField(field), "field must belong to this profile"); fields.remove(field); } @@ -334,7 +415,7 @@ public class Profile implements Fingerprintable { * @return The index of the field, or {@code -1} if there is no field with * the given name */ - private int getFieldIndex(Field field) { + private int getFieldIndex(@Nonnull Field field) { return fields.indexOf(field); } @@ -347,40 +428,41 @@ 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(); } /** * Container for a profile field. - * - * @author David ‘Bombe’ Roden */ public class Field { @@ -406,9 +488,8 @@ public class Profile implements Fingerprintable { * @param id * The ID of the field */ - private Field(String id) { - Validation.begin().isNotNull("Field ID", id).check(); - this.id = id; + private Field(@Nonnull String id) { + this.id = checkNotNull(id, "id must not be null"); } /** @@ -416,6 +497,7 @@ public class Profile implements Fingerprintable { * * @return The ID of this field */ + @Nonnull public String getId() { return id; } @@ -425,6 +507,7 @@ public class Profile implements Fingerprintable { * * @return The name of this field */ + @Nonnull public String getName() { return name; } @@ -438,8 +521,10 @@ public class Profile implements Fingerprintable { * 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(); + @Nonnull + public Field setName(@Nonnull String name) { + checkNotNull(name, "name must not be null"); + checkArgument(getFieldByName(name) == null, "name must be unique"); this.name = name; return this; } @@ -449,6 +534,7 @@ public class Profile implements Fingerprintable { * * @return The value of this field */ + @Nullable public String getValue() { return value; } @@ -462,7 +548,8 @@ public class Profile implements Fingerprintable { * The new value of this field * @return This field */ - public Field setValue(String value) { + @Nonnull + public Field setValue(@Nullable String value) { this.value = value; return this; } @@ -493,4 +580,14 @@ public class Profile implements Fingerprintable { } + /** + * Exception that signals the addition of a field with an empty name. + */ + public static class EmptyFieldName extends IllegalArgumentException { } + + /** + * Exception that signals the addition of a field that already exists. + */ + public static class DuplicateField extends IllegalArgumentException { } + }