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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of docbook-highlight Show documentation

DocBook highlight

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;

/**
 * 
 * A parameter for a command. A parameter identifies a type of information that
 * the command might accept. For example, a "Show View" command might accept the
 * id of a view for display. This parameter also identifies possible values, for
 * display in the user interface.
 * 
 * 
 * @since 3.1
 */
public interface IParameter {

	/**
	 * Returns the identifier for this parameter.
	 * 
	 * @return The identifier; never null.
	 */
	public String getId();

	/**
	 * Returns the human-readable name for this parameter.
	 * 
	 * @return The parameter name; never null.
	 */
	public String getName();

	/**
	 * Returns the values associated with this parameter.
	 * 
	 * @return The values associated with this parameter. This must not be
	 *         null.
	 * @throws ParameterValuesException
	 *             If the values can't be retrieved for some reason.
	 */
	public IParameterValues getValues() throws ParameterValuesException;

	/**
	 * Returns whether parameter is optional. Otherwise, it is required.
	 * 
	 * @return true if the parameter is optional;
	 *         false if it is required.
	 */
	public boolean isOptional();
}