KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > core > commands > IParameterValues


1 /*******************************************************************************
2  * Copyright (c) 2005 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  ******************************************************************************/
11
12 package org.eclipse.core.commands;
13
14 import java.util.Map JavaDoc;
15
16 /**
17  * <p>
18  * The parameters for a command. This interface will only be consulted if the
19  * parameters need to be displayed to the user. Otherwise, they will be ignored.
20  * </p>
21  *
22  * @since 3.1
23  */
24 public interface IParameterValues {
25
26     /**
27      * Returns a map keyed by externalized names for parameter values. These
28      * names should be human-readable, and are generally for display to the user
29      * in a user interface of some sort. The values should be actual values that
30      * will be interpreted by the handler for the command.
31      *
32      * @return A map of the externalizable name of the parameter value (<code>String</code>)
33      * to the actual value of the parameter (<code>String</code>).
34      */
35     public Map JavaDoc getParameterValues();
36 }
37
Popular Tags