X-Git-Url: https://git.pterodactylus.net/?p=Sone.git;a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fnet%2Fpterodactylus%2Fsone%2Fdata%2FProfile.java;h=6c0b435f11e50caaeec1865eadbb802dc552a2c5;hp=0c86732fb4a979f872620933dbeabfd6f50e5382;hb=c9e306ac8e3ada846e87a0cc256a20fc148f381c;hpb=8c251a1b15c1d8a8a2766e55e6decf10e9330bbe diff --git a/src/main/java/net/pterodactylus/sone/data/Profile.java b/src/main/java/net/pterodactylus/sone/data/Profile.java index 0c86732..6c0b435 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 @@ /* - * FreenetSone - Profile.java - Copyright © 2010 David Roden + * Sone - Profile.java - Copyright © 2010 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 @@ -19,10 +19,8 @@ package net.pterodactylus.sone.data; import java.util.ArrayList; import java.util.Collections; -import java.util.HashMap; -import java.util.LinkedHashMap; import java.util.List; -import java.util.Map; +import java.util.UUID; import net.pterodactylus.util.validation.Validation; @@ -34,6 +32,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; @@ -52,17 +53,20 @@ public class Profile implements Fingerprintable { /** The year of the birth date. */ private volatile Integer birthYear; - /** Additional fields in the profile. */ - private final List fields = Collections.synchronizedList(new ArrayList()); + /** The ID of the avatar image. */ + private volatile String avatar; - /** The field values. */ - private final Map fieldValues = Collections.synchronizedMap(new HashMap()); + /** 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; } /** @@ -72,16 +76,15 @@ 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.fieldValues.putAll(profile.fieldValues); + this.avatar = profile.avatar; + this.fields.addAll(profile.fields); } // @@ -89,6 +92,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 @@ -203,165 +215,156 @@ public class Profile implements Fingerprintable { } /** - * Sets the year of the birth date. + * Returns the ID of the currently selected avatar image. * - * @param birthYear - * The year of the birth date - * @return This profile (for method chaining) + * @return The ID of the currently selected avatar image, or {@code null} if + * no avatar is selected. */ - public Profile setBirthYear(Integer birthYear) { - this.birthYear = birthYear; - return this; + public String getAvatar() { + return avatar; } /** - * Appends a new field to the list of fields. + * Sets the avatar image. * - * @param field - * The field to add - * @throws IllegalArgumentException - * if the name is not valid + * @param avatar + * The new avatar image, or {@code null} to not select an avatar + * image. + * @return This Sone */ - public void addField(String field) throws IllegalArgumentException { - Validation.begin().isNotNull("Field Name", field).check().isGreater("Field Name Length", field.length(), 0).isEqual("Field Name Unique", !fields.contains(field), true).check(); - fields.add(field); - } - - /** - * Moves the field with the given index 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 fieldIndex - * The index of the field to move - */ - public void moveFieldUp(int fieldIndex) { - Validation.begin().isGreater("Field Index", fieldIndex, 0).isLess("Field Index", fieldIndex, fields.size()).check(); - String field = fields.remove(fieldIndex); - fields.add(fieldIndex - 1, field); + public Profile setAvatar(Image avatar) { + if (avatar == null) { + this.avatar = null; + return this; + } + Validation.begin().isEqual("Image Owner", avatar.getSone(), sone).check(); + this.avatar = avatar.getId(); + return this; } /** - * Moves the field with the given name up one position in the field list. - * The field must not be the first field (because you obviously can not move - * the first field further up). + * Sets the year of the birth date. * - * @param field - * The name of the field to move + * @param birthYear + * The year of the birth date + * @return This profile (for method chaining) */ - public void moveFieldUp(String field) { - Validation.begin().isNotNull("Field Name", field).check().isGreater("Field Name Length", field.length(), 0).isEqual("Field Name Existing", fields.contains(field), true).check(); - moveFieldUp(getFieldIndex(field)); + public Profile setBirthYear(Integer birthYear) { + this.birthYear = birthYear; + return this; } /** - * Moves the field with the given index 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). + * Returns the fields of this profile. * - * @param fieldIndex - * The index of the field to move + * @return The fields of this profile */ - public void moveFieldDown(int fieldIndex) { - Validation.begin().isGreaterOrEqual("Field Index", fieldIndex, 0).isLess("Field Index", fieldIndex, fields.size() - 1).check(); - String field = fields.remove(fieldIndex); - fields.add(fieldIndex + 1, field); + public List getFields() { + return new ArrayList(fields); } /** - * Moves the field with the given name down one position in the field list. - * The field must not be the last field (because you obviously can not move - * the last field further down). + * Returns whether this profile contains the given field. * * @param field - * The name of the field to move - */ - public void moveFieldDown(String field) { - Validation.begin().isNotNull("Field Name", field).check().isGreater("Field Name Length", field.length(), 0).isEqual("Field Name Existing", fields.contains(field), true).check(); - moveFieldDown(getFieldIndex(field)); - } - - /** - * Removes the field at the given index. - * - * @param fieldIndex - * The index of the field to remove + * The field to check for + * @return {@code true} if this profile contains the field, false otherwise */ - public void removeField(int fieldIndex) { - Validation.begin().isGreaterOrEqual("Field Index", fieldIndex, 0).isLess("Field Index", fieldIndex, fields.size()).check(); - String field = fields.remove(fieldIndex); - fieldValues.remove(field); + public boolean hasField(Field field) { + return fields.contains(field); } /** - * Removes the field with the given name. + * Returns the field with the given ID. * - * @param field - * The name of the field + * @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 void removeField(String field) { - Validation.begin().isNotNull("Field Name", field).check().isGreater("Field Name Length", field.length(), 0).isEqual("Field Name Existing", fields.contains(field), true).check(); - removeField(getFieldIndex(field)); + public Field getFieldById(String fieldId) { + Validation.begin().isNotNull("Field ID", fieldId).check(); + for (Field field : fields) { + if (field.getId().equals(fieldId)) { + return field; + } + } + return null; } /** - * Returns the value of the field with the given name. + * Returns the field with the given name. * - * @param field - * The name of the field - * @return The value of the field, or {@code null} if there is no such field + * @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 String getField(String field) { - return fieldValues.get(field); + public Field getFieldByName(String fieldName) { + for (Field field : fields) { + if (field.getName().equals(fieldName)) { + return field; + } + } + return null; } /** - * Sets the value of the field with the given name. + * Appends a new field to the list of fields. * - * @param fieldIndex - * The index of the field - * @param value - * The value of the field + * @param fieldName + * The name of the new field + * @return The new field + * @throws IllegalArgumentException + * if the name is not valid */ - public void setField(int fieldIndex, String value) { - Validation.begin().isGreaterOrEqual("Field Index", fieldIndex, 0).isLess("Field Index", fieldIndex, fields.size()).check(); - setField(fields.get(fieldIndex), value); + 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(); + @SuppressWarnings("synthetic-access") + Field field = new Field().setName(fieldName); + fields.add(field); + return field; } /** - * Sets the value of the field with the given name. + * 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 name of the field - * @param value - * The value of the field + * The field to move up */ - public void setField(String field, String value) { - Validation.begin().isNotNull("Field Name", field).check().isGreater("Field Name Length", field.length(), 0).isEqual("Field Name Existing", fields.contains(field), true).check(); - fieldValues.put(field, value); + public void moveFieldUp(Field field) { + Validation.begin().isNotNull("Field", field).check().is("Field Existing", hasField(field)).isGreater("Field Index", getFieldIndex(field), 0).check(); + int fieldIndex = getFieldIndex(field); + fields.remove(field); + fields.add(fieldIndex - 1, field); } /** - * Returns a list of all fields stored in this profile. + * 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). * - * @return The fields of this profile + * @param field + * The field to move down */ - public List getFieldNames() { - return Collections.unmodifiableList(fields); + 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(); + int fieldIndex = getFieldIndex(field); + fields.remove(field); + fields.add(fieldIndex + 1, field); } /** - * Returns all field names and their values, ordered the same way - * {@link #getFieldNames()} returns the names of the fields. + * Removes the given field. * - * @return All field names and values + * @param field + * The field to remove */ - public Map getFields() { - Map fields = new LinkedHashMap(); - for (String field : getFieldNames()) { - fields.put(field, getField(field)); - } - return fields; + public void removeField(Field field) { + Validation.begin().isNotNull("Field", field).check().is("Field Existing", hasField(field)).check(); + fields.remove(field); } // @@ -376,7 +379,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(String field) { + private int getFieldIndex(Field field) { return fields.indexOf(field); } @@ -409,9 +412,12 @@ public class Profile implements Fingerprintable { if (birthYear != null) { fingerprint.append("BirthYear(").append(birthYear).append(')'); } + if (avatar != null) { + fingerprint.append("Avatar(").append(avatar).append(')'); + } fingerprint.append("ContactInformation("); - for (String field : fields) { - fingerprint.append(field).append('(').append(fieldValues.get(field)).append(')'); + for (Field field : fields) { + fingerprint.append(field.getName()).append('(').append(field.getValue()).append(')'); } fingerprint.append(")"); fingerprint.append(")"); @@ -419,4 +425,120 @@ public class Profile implements Fingerprintable { return fingerprint.toString(); } + /** + * Container for a profile field. + * + * @author David ‘Bombe’ Roden + */ + public class Field { + + /** The ID of the field. */ + private final String id; + + /** The name of the field. */ + private String name; + + /** The value of the field. */ + private String value; + + /** + * Creates a new field with a random ID. + */ + private Field() { + this(UUID.randomUUID().toString()); + } + + /** + * 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; + } + + /** + * 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)) { + return false; + } + Field field = (Field) object; + return id.equals(field.id); + } + + /** + * {@inheritDoc} + */ + @Override + public int hashCode() { + return id.hashCode(); + } + + } + }