StringWithDescription.java

package de.blau.android.util;

import java.io.Serializable;
import java.text.Collator;
import java.util.Comparator;

import android.support.annotation.NonNull;
import de.blau.android.presets.ValueWithCount;

@SuppressWarnings("NullableProblems")
public class StringWithDescription implements Comparable<StringWithDescription>, Serializable {
	private static final long serialVersionUID = 1L;
	
	private final String value;
	private String description;
	
	public StringWithDescription(final String value) {
		this.value = value;
	}
	
	public StringWithDescription(final String value, final String description) {
		this.value = value;
		this.description = description;
	}
	
	public StringWithDescription(Object o) {
		if (o instanceof ValueWithCount) {
			value = ((ValueWithCount)o).getValue();
			description = ((ValueWithCount)o).getDescription();
		} else if (o instanceof StringWithDescription) {
			value = ((StringWithDescription)o).getValue();
			description = ((StringWithDescription)o).getDescription();
		} else if (o instanceof String) {
			value = (String)o;
			description = value;
		} else {
			value = "";
			description=value;
		}
	}
	
	/**
	 * @return the value
	 */
	public String getValue() {
		return value;
	}

	/**
	 * @return the description
	 */
	public String getDescription() {
		return description;
	}

	@Override
	public String toString() {
		return value + (description != null ? (value == null || "".equals(value) ? "" : " - ") + description:"");
	}

	@Override
	public int compareTo(@NonNull StringWithDescription s) {
		return value.compareTo(s.getValue());
	}
	
	/**
	 * This is likely bad style
	 * @param s
	 * @return
	 */
	public boolean equals(String s) {
		return this.value.equals(s);
	}
	
	@Override
	public boolean equals(Object o) {
		return o instanceof StringWithDescription && this == (StringWithDescription)o
				|| (this.value.equals(((StringWithDescription)o).value) && ((this.description == null && ((StringWithDescription)o).description == null) || (this.description != null && this.description.equals(((StringWithDescription)o).description))));
	}
	
	@Override
	public int hashCode() {
		int result = 1;
		result = 37 * result + (value == null ? 0 : value.hashCode());
		result = 37 * result + (description == null ? 0 : description.hashCode());
		return result;
	}
	
	/**
	 * 
	 * @author simon
	 *
	 */
	public static class LocaleComparator implements Comparator<StringWithDescription> {

		Collator defaultLocaleCollator = Collator.getInstance();
		
		@Override
		public int compare(StringWithDescription lhs, StringWithDescription rhs) {
			String lhsDescription = lhs.getDescription();
			if (lhsDescription == null || "".equals(lhsDescription)) {
				lhsDescription = lhs.getValue();
			}
			String rhsDescription = rhs.getDescription();
			if (rhsDescription == null || "".equals(rhsDescription)) {
				rhsDescription = rhs.getValue();
			}
			return defaultLocaleCollator.compare(lhsDescription,rhsDescription);
		}		
	}
}