org.scijava.event.EventDetails Maven / Gradle / Ivy

Go to download
/*
 * #%L
 * SciJava Common shared library for SciJava software.
 * %%
 * Copyright (C) 2009 - 2017 Board of Regents of the University of
 * Wisconsin-Madison, Broad Institute of MIT and Harvard, Max Planck
 * Institute of Molecular Cell Biology and Genetics, University of
 * Konstanz, and KNIME GmbH.
 * %%
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 * #L%
 */

package org.scijava.event;

import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Locale;

/**
 * Caches details of a particular {@link SciJavaEvent}, without saving the event
 * itself (since doing so could leave dangling references).
 * 
 * @author Curtis Rueden
 */
public class EventDetails {

	private final Date timestamp;
	private final Class eventType;
	private final String eventString;

	public EventDetails(final SciJavaEvent event) {
		timestamp = new Date();
		eventType = event.getClass();
		eventString = event.toString();
	}

	// -- EventDetails methods --

	public Class getEventType() {
		return eventType;
	}

	public Date getTimestamp() {
		return timestamp;
	}

	public String getEventString() {
		return eventString;
	}

	public String toHTML(final boolean bold) {
		final StringBuilder sb = new StringBuilder();
		sb.append("");

		// append timestamp
		sb.append("[");
		sb.append(timestampAsString());
		sb.append("] ");

		// append event class name
		sb.append("");
		sb.append(eventType.getSimpleName());
		sb.append("");

		// append event string
		sb.append("");
		sb.append(htmlize(eventString));
		sb.append("");

		if (bold) sb.append("");
		sb.append("");
		return sb.toString();
	}

	// -- Helper methods --

	private String timestampAsString() {
		final SimpleDateFormat formatter =
			new SimpleDateFormat("hh:mm:ss.SS", Locale.getDefault());
		final String dateStr = formatter.format(timestamp);
		return dateStr;
	}

	private String htmlize(final String s) {
		final String tab = "    ";
		return s.replaceAll("\\t", tab).replaceAll("\\n", "
");
	}

}