org.scijava.io.event.IOEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of scijava-common Show documentation

SciJava Common is a shared library for SciJava software. It provides a plugin framework, with an extensible mechanism for service discovery, backed by its own annotation processor, so that plugins can be loaded dynamically. It is used by downstream projects in the SciJava ecosystem, such as ImageJ and SCIFIO.

The newest version!

/*
 * #%L
 * SciJava Common shared library for SciJava software.
 * %%
 * Copyright (C) 2009 - 2024 SciJava developers.
 * %%
 * 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.io.event;

import java.net.URISyntaxException;

import org.scijava.event.SciJavaEvent;
import org.scijava.io.location.FileLocation;
import org.scijava.io.location.Location;
import org.scijava.io.location.LocationService;

/**
 * An event indicating that I/O (e.g., opening or saving) has occurred.
 * 
 * @author Curtis Rueden
 */
public abstract class IOEvent extends SciJavaEvent {

	/** The data location (source or destination). */
	private final Location location;

	/** @deprecated use {@link #location} instead */
	@Deprecated
	private final String descriptor;

	/** The data for which I/O took place. */
	private final Object data;

	/**
	 * @deprecated use {@link #IOEvent(Location, Object)} instead
	 */
	@Deprecated
	public IOEvent(final String descriptor, final Object data) {
		this.location = null;
		this.descriptor = descriptor;
		this.data = data;
	}

	public IOEvent(final Location location, final Object data) {
		this.location = location;
		this.descriptor = null;
		this.data = data;
	}

	/** Gets the data location (source or destination). */
	public Location getLocation() {
		if (location != null) return location;
		try {
			return context().service(LocationService.class).resolve(descriptor);
		}
		catch (final URISyntaxException exc) {
			return null;
		}
	}

	/** Gets the data for which I/O took place. */
	public Object getData() {
		return data;
	}

	// -- Object methods --

	@Override
	public String toString() {
		return super.toString() + "\n\tlocation = " + location + "\n\tdata = " +
			data;
	}

	/**
	 * @deprecated use {@link #getLocation()} instead
	 */
	@Deprecated
	public String getDescriptor() {
		if (descriptor != null) return descriptor;
		if (location instanceof FileLocation) {
			final FileLocation fileLocation = (FileLocation) location;
			return fileLocation.getFile().getAbsolutePath();
		}
		return location.getURI().toString();
	}
}