org.eclipse.core.commands.IParameterValues Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spotless-ext-greclipse Show documentation

Groovy Eclipse's formatter bundled for Spotless

The newest version!

/*******************************************************************************
 * Copyright (c) 2005 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 ******************************************************************************/

package org.eclipse.core.commands;

import java.util.Map;

/**
 * 
 * The parameters for a command. This interface will only be consulted if the
 * parameters need to be displayed to the user. Otherwise, they will be ignored.
 * 
 * 
 * @since 3.1
 */
public interface IParameterValues {

	/**
	 * Returns a map keyed by externalized names for parameter values. These
	 * names should be human-readable, and are generally for display to the user
	 * in a user interface of some sort. The values should be actual values that
	 * will be interpreted by the handler for the command.
	 * 
	 * @return A map of the externalizable name of the parameter value (String)
	 *         to the actual value of the parameter (String).
	 */
	public Map getParameterValues();
}