com.google.appengine.api.datastore.IMHandle Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of objectify-gwt Show documentation
Use Google App Engine datastore and Objectify classes with GWT
There is a newer version: 1.2.1
// Copyright 2009 Google Inc. All Rights Reserved.
package com.google.appengine.api.datastore;

import java.io.Serializable;
import java.net.URL;

/**
 * An instant messaging handle. Includes both an address and its protocol. The
 * protocol value is either a standard IM scheme (legal scheme values are
 * defined by {@link Scheme} or a URL identifying the IM network for the
 * protocol (e.g. http://aim.com/).
 *
 */
public final class IMHandle implements Serializable, Comparable {

	public static final long serialVersionUID = 6963426833434504530L;

	/**
	 * Supported IM schemes.
	 */
	public enum Scheme {
		sip, unknown, xmpp
	}

	private String protocol;
	private String address;

	public IMHandle(Scheme scheme, String address) {
		if (scheme == null) {
			throw new NullPointerException("scheme must not be null");
		}
		validateAddress(address);
		this.protocol = scheme.name();
		this.address = address;
	}

// URL is not part of GWT JRE emulation
//
//	public IMHandle(URL network, String address) {
//		if (network == null) {
//			throw new NullPointerException("network must not be null");
//		}
//		validateAddress(address);
//		this.protocol = network.toString();
//		this.address = address;
//	}

	/**
	 * This constructor exists for frameworks (e.g. Google Web Toolkit) that
	 * require it for serialization purposes. It should not be called
	 * explicitly.
	 */
	@SuppressWarnings("unused")
	private IMHandle() {
		this.protocol = null;
		this.address = null;
	}

	/**
	 * Constructs an {@code IMHandle} from a string in the format returned by
	 * {@link #toDatastoreString()}.
	 *
	 * @throws IllegalArgumentException
	 *             If the provided string does not match the format returned by
	 *             {@link #toDatastoreString()} or the first component of the
	 *             string is not a valid {@link Scheme} and is not a valid
	 *             {@link URL}.
	 */
// URL and MalformedURLException are not part of GWT JRE emulation
//
//	static IMHandle fromDatastoreString(String datastoreString) {
//		if (datastoreString == null) {
//			throw new NullPointerException("datastoreString must not be null");
//		}
//		String[] split = datastoreString.split(" ", 2);
//		if (split.length != 2) {
//			throw new IllegalArgumentException("Datastore string must have at least one space: " + datastoreString);
//		}
//		try {
//			return new IMHandle(IMHandle.Scheme.valueOf(split[0]), split[1]);
//		} catch (IllegalArgumentException iae) {
//			try {
//				return new IMHandle(new URL(split[0]), split[1]);
//			} catch (MalformedURLException e) {
//				throw new IllegalArgumentException("String in datastore could not be parsed into a valid IMHandle.  "
//						+ "Protocol must either be a valid scheme or url: " + split[0]);
//			}
//		}
//	}

	private static void validateAddress(String address) {
		if (address == null) {
			throw new NullPointerException("address must not be null");
		}
	}

	/**
	 * The datastore representation of the {@code IMHandle}. This must not
	 * change.
	 */
	String toDatastoreString() {
		// GWT JRE emulation missing
		//return String.format("%s %s", protocol, address);
		return protocol + " " + address;
	}

	public String getProtocol() {
		return protocol;
	}

	public String getAddress() {
		return address;
	}

	@Override
	public boolean equals(Object o) {
		if (this == o) {
			return true;
		}
		if (o == null || getClass() != o.getClass()) {
			return false;
		}

		IMHandle imHandle = (IMHandle) o;

		if (!address.equals(imHandle.address)) {
			return false;
		}
		if (!protocol.equals(imHandle.protocol)) {
			return false;
		}

		return true;
	}

	@Override
	public int hashCode() {
		int result;
		result = protocol.hashCode();
		result = 31 * result + address.hashCode();
		return result;
	}

	/**
	 * Sorts first by protocol, then by address.
	 */
	@Override
	public int compareTo(IMHandle o) {
		return toDatastoreString().compareTo(o.toDatastoreString());
	}

	@Override
	public String toString() {
		return toDatastoreString();
	}
}