/*
- * Sone - Profile.java - Copyright © 2010–2013 David Roden
+ * Sone - Profile.java - Copyright © 2010–2020 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
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.nio.charset.StandardCharsets.UTF_8;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.UUID;
+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 <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
*/
public class Profile implements Fingerprintable {
* @param profile
* The profile to copy
*/
- public Profile(Profile profile) {
+ public Profile(@Nonnull Profile profile) {
this.sone = profile.sone;
this.firstName = profile.firstName;
this.middleName = profile.middleName;
*
* @return The Sone this profile belongs to
*/
+ @Nonnull
public Sone getSone() {
return sone;
}
*
* @return The first name
*/
+ @Nullable
public String getFirstName() {
return firstName;
}
* The first name to set
* @return This profile (for method chaining)
*/
- public Profile setFirstName(String firstName) {
- this.firstName = firstName;
+ @Nonnull
+ public Profile setFirstName(@Nullable String firstName) {
+ this.firstName = "".equals(firstName) ? null : firstName;
return this;
}
*
* @return The middle name
*/
+ @Nullable
public String getMiddleName() {
return middleName;
}
* The middle name to set
* @return This profile (for method chaining)
*/
- public Profile setMiddleName(String middleName) {
- this.middleName = middleName;
+ @Nonnull
+ public Profile setMiddleName(@Nullable String middleName) {
+ this.middleName = "".equals(middleName) ? null : middleName;
return this;
}
*
* @return The last name
*/
+ @Nullable
public String getLastName() {
return lastName;
}
* The last name to set
* @return This profile (for method chaining)
*/
- public Profile setLastName(String lastName) {
- this.lastName = lastName;
+ @Nonnull
+ public Profile setLastName(@Nullable String lastName) {
+ this.lastName = "".equals(lastName) ? null : lastName;
return this;
}
*
* @return The day of the birth date (from 1 to 31)
*/
+ @Nullable
public Integer getBirthDay() {
return birthDay;
}
* 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;
}
*
* @return The month of the birth date (from 1 to 12)
*/
+ @Nullable
public Integer getBirthMonth() {
return birthMonth;
}
* 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;
}
*
* @return The year of the birth date
*/
+ @Nullable
public Integer getBirthYear() {
return birthYear;
}
* @return The ID of the currently selected avatar image, or {@code null} if
* no avatar is selected.
*/
+ @Nullable
public String getAvatar() {
return avatar;
}
* image.
* @return This Sone
*/
- public Profile setAvatar(Image avatar) {
+ @Nonnull
+ public Profile setAvatar(@Nullable Image avatar) {
if (avatar == null) {
this.avatar = null;
return this;
* 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;
}
*
* @return The fields of this profile
*/
+ @Nonnull
public List<Field> getFields() {
- return new ArrayList<Field>(fields);
+ return new ArrayList<>(fields);
}
/**
* 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);
}
* @return The field, or {@code null} if this profile does not contain a
* field with the given ID
*/
- public Field getFieldById(String fieldId) {
+ @Nullable
+ public Field getFieldById(@Nonnull String fieldId) {
checkNotNull(fieldId, "fieldId must not be null");
for (Field field : fields) {
if (field.getId().equals(fieldId)) {
* @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;
* @throws IllegalArgumentException
* if the name is not valid
*/
- public Field addField(String fieldName) throws IllegalArgumentException {
+ @Nonnull
+ public Field addField(@Nonnull String fieldName) throws IllegalArgumentException {
checkNotNull(fieldName, "fieldName must not be null");
- checkArgument(fieldName.length() > 0, "fieldName must not be empty");
+ 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;
}
* @param field
* The field to move up
*/
- public void moveFieldUp(Field field) {
+ 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");
* @param field
* The field to move down
*/
- public void moveFieldDown(Field field) {
+ 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));
* @param field
* The field to remove
*/
- public void removeField(Field field) {
+ 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);
* @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);
}
@Override
public String getFingerprint() {
Hasher hash = Hashing.sha256().newHasher();
- hash.putString("Profile(");
+ hash.putString("Profile(", UTF_8);
if (firstName != null) {
- hash.putString("FirstName(").putString(firstName).putString(")");
+ hash.putString("FirstName(", UTF_8).putString(firstName, UTF_8).putString(")", UTF_8);
}
if (middleName != null) {
- hash.putString("MiddleName(").putString(middleName).putString(")");
+ hash.putString("MiddleName(", UTF_8).putString(middleName, UTF_8).putString(")", UTF_8);
}
if (lastName != null) {
- hash.putString("LastName(").putString(lastName).putString(")");
+ hash.putString("LastName(", UTF_8).putString(lastName, UTF_8).putString(")", UTF_8);
}
if (birthDay != null) {
- hash.putString("BirthDay(").putInt(birthDay).putString(")");
+ hash.putString("BirthDay(", UTF_8).putInt(birthDay).putString(")", UTF_8);
}
if (birthMonth != null) {
- hash.putString("BirthMonth(").putInt(birthMonth).putString(")");
+ hash.putString("BirthMonth(", UTF_8).putInt(birthMonth).putString(")", UTF_8);
}
if (birthYear != null) {
- hash.putString("BirthYear(").putInt(birthYear).putString(")");
+ hash.putString("BirthYear(", UTF_8).putInt(birthYear).putString(")", UTF_8);
}
if (avatar != null) {
- hash.putString("Avatar(").putString(avatar).putString(")");
+ hash.putString("Avatar(", UTF_8).putString(avatar, UTF_8).putString(")", UTF_8);
}
- hash.putString("ContactInformation(");
+ hash.putString("ContactInformation(", UTF_8);
for (Field field : fields) {
- hash.putString(field.getName()).putString("(").putString(field.getValue()).putString(")");
+ hash.putString(field.getName(), UTF_8).putString("(", UTF_8).putString(field.getValue(), UTF_8).putString(")", UTF_8);
}
- hash.putString(")");
- hash.putString(")");
+ hash.putString(")", UTF_8);
+ hash.putString(")", UTF_8);
return hash.hash().toString();
}
/**
* Container for a profile field.
- *
- * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
*/
public class Field {
* @param id
* The ID of the field
*/
- private Field(String id) {
+ private Field(@Nonnull String id) {
this.id = checkNotNull(id, "id must not be null");
}
*
* @return The ID of this field
*/
+ @Nonnull
public String getId() {
return id;
}
*
* @return The name of this field
*/
+ @Nonnull
public String getName() {
return name;
}
* The new name of this field
* @return This field
*/
- public Field setName(String name) {
+ @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 The value of this field
*/
+ @Nullable
public String getValue() {
return value;
}
* 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;
}
}
/**
+ * 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.
- *
- * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
*/
public static class DuplicateField extends IllegalArgumentException { }
projects / Sone.git / blobdiff