ecommons.waltable/org.eclipse.statet.ecommons.waltable.core/src/org/eclipse/statet/ecommons/waltable/tickupdate/TickUpdateCommand.java

/*=============================================================================#
 # Copyright (c) 2012, 2020 Original NatTable authors and others.
 # 
 # This program and the accompanying materials are made available under the
 # terms of the Eclipse Public License 2.0 which is available at
 # https://www.eclipse.org/legal/epl-2.0.
 # 
 # SPDX-License-Identifier: EPL-2.0
 # 
 # Contributors:
 #     Original NatTable authors and others - initial API and implementation
 #=============================================================================*/

package org.eclipse.statet.ecommons.waltable.tickupdate;

import org.eclipse.statet.ecommons.waltable.command.ILayerCommand;
import org.eclipse.statet.ecommons.waltable.config.IConfigRegistry;
import org.eclipse.statet.ecommons.waltable.layer.ILayer;


/**
 * Command to trigger a tick update on the current selected cells.
 * Note: This command only works if the layer composition contains a
 * 		 SelectionLayer and the corresponding {@link TickUpdateCommandHandler}
 * 		 is registered.
 */
public class TickUpdateCommand implements ILayerCommand {

	/**
	 * The {@link IConfigRegistry} of the current NatTable instance this
	 * command is executed in. Needed to determine several configurations
	 * on handling this command by its handler.
	 * As the command handler is not aware of the NatTable instance it
	 * is running in, and there is no kind of context, the {@link IConfigRegistry}
	 * needs to be transported.
	 */
	private final IConfigRegistry configRegistry;
	/**
	 * Flag to determine whether the current value in the data model
	 * should be incremented or decremented. 
	 */
	private final boolean increment;

	/**
	 * @param configRegistry The {@link IConfigRegistry} of the current NatTable instance this
	 * 			command is executed in. Needed to determine several configurations
	 * 			on handling this command by its handler.
	 * 			As the command handler is not aware of the NatTable instance it
	 * 			is running in, and there is no kind of context, the {@link IConfigRegistry}
	 * 			needs to be transported.
	 * @param increment Flag to determine whether the current value in the data model
	 * 			should be incremented or decremented. 
	 */
	public TickUpdateCommand(final IConfigRegistry configRegistry, final boolean increment) {
		this.configRegistry= configRegistry;
		this.increment= increment;
	}

	/**
	 * Constructor that is used by local cloning operation.
	 * @param command The command to create a new instance of.
	 */
	protected TickUpdateCommand(final TickUpdateCommand command) {
		this.configRegistry= command.configRegistry;
		this.increment= command.increment;
	}
	
	@Override
	public TickUpdateCommand cloneCommand() {
		return new TickUpdateCommand(this);
	}

	@Override
	public boolean convertToTargetLayer(final ILayer targetLayer) {
		// No op.
		return true;
	}
	
	/**
	 * @return The {@link IConfigRegistry} of the current NatTable instance this
	 * 			command is executed in. Needed to determine several configurations
	 * 			on handling this command by its handler.
	 * 			As the command handler is not aware of the NatTable instance it
	 * 			is running in, and there is no kind of context, the {@link IConfigRegistry}
	 * 			needs to be transported.
	 */
	public IConfigRegistry getConfigRegistry() {
		return this.configRegistry;
	}

	/**
	 * @return Whether the current value in the data model
	 * 			should be incremented or decremented.
	 */
	public boolean isIncrement() {
		return this.increment;
	}
}