X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fnet%2Fpterodactylus%2Fsone%2Fdata%2FProfile.java;h=d3ce38e917c12d037ec4f33cb02c48c5d5c6ba06;hb=242da074894d2ffcbb1a61f16ed881db9bc51ff0;hp=9c7da484a7854e4aabf3f7a04e5d21b2836b0836;hpb=b2e3ba7456f47f01552c8e1300e295c48d8fe9a8;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 9c7da48..d3ce38e 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â2013 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
@@ -26,14 +26,15 @@ 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 David âBombeâ Roden
*/
public class Profile implements Fingerprintable {
@@ -80,7 +81,7 @@ 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;
@@ -101,6 +102,7 @@ public class Profile implements Fingerprintable {
*
* @return The Sone this profile belongs to
*/
+ @Nonnull
public Sone getSone() {
return sone;
}
@@ -110,6 +112,7 @@ public class Profile implements Fingerprintable {
*
* @return The first name
*/
+ @Nullable
public String getFirstName() {
return firstName;
}
@@ -121,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;
}
@@ -131,6 +135,7 @@ public class Profile implements Fingerprintable {
*
* @return The middle name
*/
+ @Nullable
public String getMiddleName() {
return middleName;
}
@@ -142,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;
}
@@ -152,6 +158,7 @@ public class Profile implements Fingerprintable {
*
* @return The last name
*/
+ @Nullable
public String getLastName() {
return lastName;
}
@@ -163,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;
}
@@ -173,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;
}
@@ -184,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;
}
@@ -194,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;
}
@@ -205,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;
}
@@ -215,6 +227,7 @@ public class Profile implements Fingerprintable {
*
* @return The year of the birth date
*/
+ @Nullable
public Integer getBirthYear() {
return birthYear;
}
@@ -225,6 +238,7 @@ public class Profile implements Fingerprintable {
* @return The ID of the currently selected avatar image, or {@code null} if
* no avatar is selected.
*/
+ @Nullable
public String getAvatar() {
return avatar;
}
@@ -237,7 +251,8 @@ public class Profile implements Fingerprintable {
* image.
* @return This Sone
*/
- public Profile setAvatar(Image avatar) {
+ @Nonnull
+ public Profile setAvatar(@Nullable Image avatar) {
if (avatar == null) {
this.avatar = null;
return this;
@@ -254,7 +269,8 @@ public class Profile implements Fingerprintable {
* 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;
}
@@ -264,6 +280,7 @@ public class Profile implements Fingerprintable {
*
* @return The fields of this profile
*/
+ @Nonnull
public List getFields() {
return new ArrayList(fields);
}
@@ -275,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);
}
@@ -287,7 +304,8 @@ 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) {
+ @Nullable
+ public Field getFieldById(@Nonnull String fieldId) {
checkNotNull(fieldId, "fieldId must not be null");
for (Field field : fields) {
if (field.getId().equals(fieldId)) {
@@ -305,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;
@@ -323,9 +342,12 @@ public class Profile implements Fingerprintable {
* @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();
}
@@ -343,7 +365,7 @@ public class Profile implements Fingerprintable {
* @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");
@@ -360,7 +382,7 @@ public class Profile implements Fingerprintable {
* @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));
@@ -375,7 +397,7 @@ public class Profile implements Fingerprintable {
* @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);
@@ -393,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);
}
@@ -441,8 +463,6 @@ public class Profile implements Fingerprintable {
/**
* Container for a profile field.
- *
- * @author David âBombeâ Roden
*/
public class Field {
@@ -468,7 +488,7 @@ public class Profile implements Fingerprintable {
* @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");
}
@@ -477,6 +497,7 @@ public class Profile implements Fingerprintable {
*
* @return The ID of this field
*/
+ @Nonnull
public String getId() {
return id;
}
@@ -486,6 +507,7 @@ public class Profile implements Fingerprintable {
*
* @return The name of this field
*/
+ @Nonnull
public String getName() {
return name;
}
@@ -499,7 +521,8 @@ public class Profile implements Fingerprintable {
* 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;
@@ -511,6 +534,7 @@ public class Profile implements Fingerprintable {
*
* @return The value of this field
*/
+ @Nullable
public String getValue() {
return value;
}
@@ -524,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;
}
@@ -556,9 +581,12 @@ 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.
- *
- * @author David âBombeâ Roden
*/
public static class DuplicateField extends IllegalArgumentException { }