Collectible.java

/*******************************************************************************
 * Copyright (c) 2007, 2014 compeople AG and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    compeople AG - initial API and implementation
 *******************************************************************************/
package org.eclipse.riena.monitor.common;

import java.io.Serializable;
import java.util.UUID;

import org.eclipse.core.runtime.Assert;

import org.eclipse.riena.core.util.StringUtils;

/**
 * A {@code Collectible} is the generic transportation element.
 */
public class Collectible<T extends Serializable> implements Serializable {

	private final String clientInfo;
	private final String categoryName;
	private final UUID uuid;
	private final long collectionTime;
	private final T payload;

	private static final long serialVersionUID = 1218813380792765109L;

	/**
	 * This constructor is necessary for Hessian's (Riena remote services)
	 * serialization.
	 */
	protected Collectible() {
		this.clientInfo = null;
		this.categoryName = null;
		this.uuid = null;
		this.collectionTime = 0;
		this.payload = null;
	}

	/**
	 * Create a {@code Collectible} for a given categoryName.
	 * 
	 * @param clientInfo
	 *            some information about the client
	 * @param categoryName
	 *            the categoryName for this collectible
	 * @param payload
	 *            the payload of this collectible
	 */
	public Collectible(final String clientInfo, final String categoryName, final T payload) {
		Assert.isTrue(StringUtils.isGiven(categoryName), "categoryName must not be empty"); //$NON-NLS-1$
		Assert.isNotNull(payload, "payload must not be null"); //$NON-NLS-1$
		this.clientInfo = clientInfo;
		this.categoryName = categoryName;
		this.uuid = UUID.randomUUID();
		this.collectionTime = System.currentTimeMillis();
		this.payload = payload;
	}

	public String getClientInfo() {
		return clientInfo;
	}

	/**
	 * @return the categoryName
	 */
	public String getCategory() {
		return categoryName;
	}

	public UUID getUUID() {
		return uuid;
	}

	public long getCollectionTime() {
		return collectionTime;
	}

	/**
	 * @return the payload
	 */
	public T getPayload() {
		return payload;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see java.lang.Object#equals(java.lang.Object)
	 */
	@Override
	public boolean equals(final Object obj) {
		if (!(obj instanceof Collectible<?>)) {
			return false;
		}
		return uuid.equals(((Collectible<?>) obj).uuid);
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see java.lang.Object#hashCode()
	 */
	@Override
	public int hashCode() {
		return uuid.hashCode();
	}

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

	public String toLogString() {
		return toString(false);
	}

	private String toString(final boolean verbose) {
		final StringBuilder bob = new StringBuilder("Collectible: "); //$NON-NLS-1$
		bob.append("ClientInfo={").append(clientInfo).append("},"); //$NON-NLS-1$ //$NON-NLS-2$
		bob.append("Category=").append(categoryName).append(','); //$NON-NLS-1$
		bob.append("Payload (partial)=").append(verbose ? payload : partial(payload)); //$NON-NLS-1$
		return bob.toString();
	}

	private String partial(final T payload) {
		final String all = payload.toString();
		final int cutOff = all.indexOf('\n');
		if (cutOff == -1) {
			return all;
		}
		return all.substring(0, cutOff) + " (and more ..)"; //$NON-NLS-1$
	}
}