org.scijava.module.MutableModuleInfo 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.module;

/**
 * {@link ModuleInfo} extension allowing manipulation of its metadata.
 * 
 * In particular, module inputs and outputs can be added, edited and removed.
 * 
 * 
 * Note that a {@code MutableModuleInfo} does not necessarily have
 * {@link MutableModuleItem}s!
 * 
 * 
 * @author Curtis Rueden
 * @see org.scijava.command.DynamicCommand
 */
public interface MutableModuleInfo extends ModuleInfo {

	/** Sets the module class described by this {@link ModuleInfo}. */
	void setModuleClass(Class moduleClass);

	/** Gets the module class described by this {@link ModuleInfo}. */
	Class getModuleClass();

	/** Adds an input to the list. */
	void addInput(ModuleItem input);

	/** Adds an output to the list. */
	void addOutput(ModuleItem output);

	/** Removes an input from the list. */
	void removeInput(ModuleItem input);

	/** Removes an output from the list. */
	void removeOutput(ModuleItem output);

	// -- ModuleInfo methods --

	@Override
	default String getDelegateClassName() {
		return getModuleClass().getName();
	}

	@Override
	default Class loadDelegateClass() {
		return getModuleClass();
	}

	@Override
	default Module createModule() throws ModuleException {
		try {
			return getModuleClass().newInstance();
		}
		catch (final InstantiationException | IllegalAccessException exc) {
			throw new ModuleException(exc);
		}
	}
}