AddressbookEntry.java

package chatty;

import chatty.util.StringUtil;
import java.util.HashSet;
import java.util.Objects;
import java.util.Set;

/**
 * Immutable entry for an addressbook, only containing the name and categories.
 * The categories are all made lowercase when added.
 * 
 * @author tduva
 */
public class AddressbookEntry {
    
    private final String name;
    private final Set<String> categories;
    
    /**
     * Creates a new entry.
     * 
     * @param name The name, shouldn't be empty or null, will be turned into
     * lowercase, shouldn't contain any spaces
     * @param categories The categories, can be empty, but not null
     */
    public AddressbookEntry(String name, Set<String> categories) {
        this.name = StringUtil.toLowerCase(name);
        this.categories = createCategoriesSet(categories);
    }
    
    /**
     * Creates a new entry based on another entry, but adding the given
     * categories.
     * 
     * @param other The other entry to base this new entry on.
     * @param categories The categories to add, can be empty, but not null.
     */
    public AddressbookEntry(AddressbookEntry other, Set<String> categories) {
        this.name = StringUtil.toLowerCase(other.getName());
        this.categories = createCategoriesSet(other.getCategories());
        this.categories.addAll(createCategoriesSet(categories));
    }
    
    /**
     * Creates a new Set with the given categories, making them all lowercase in
     * the process. Duplicate categories that were only differentiated by case
     * will of course be reduced to one lowercase one by the Set.
     * 
     * @param categories The categories to add to the new Set
     * @return The new Set with the categories added to it
     */
    private static Set<String> createCategoriesSet(Set<String> categories) {
        Set<String> result = new HashSet<>();
        for (String cat : categories) {
            result.add(StringUtil.toLowerCase(cat));
        }
        return result;
    }
    
    /**
     * Gets the name for this entry. Always in lowercase.
     * 
     * @return 
     */
    public String getName() {
        return name;
    }
    
    /**
     * Returns a copy of the categories.
     * 
     * @return 
     */
    public Set<String> getCategories() {
        return new HashSet<>(categories);
    }
    
    /**
     * Checks if this entry contains the given category.
     * 
     * @param category
     * @return 
     */
    public boolean hasCategory(String category) {
        if (category == null) {
            return false;
        }
        return categories.contains(StringUtil.toLowerCase(category));
    }
    
    @Override
    public String toString() {
        return name+" "+categories.toString();
    }
    
    @Override
    public boolean equals(Object o) {
        if (o instanceof AddressbookEntry) {
            return name.equals(((AddressbookEntry)o).getName());
        }
        return false;
    }

    @Override
    public int hashCode() {
        int hash = 7;
        hash = 59 * hash + Objects.hashCode(this.name);
        return hash;
    }
    
    public boolean equalsFully(AddressbookEntry o) {
        if (o == null) {
            return false;
        }
        return o.equals(this) && o.getCategories().equals(this.categories);
    }
    
}