Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.core.commands
Interface IParameter


public interface IParameter

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

Method Summary
  String getId ()
          Returns the identifier for this parameter.
  String getName ()
          Returns the human-readable name for this parameter.
  IParameterValues getValues ()
          Returns the values associated with this parameter.
 boolean isOptional ()
          Returns whether parameter is optional.
 

Method Detail

getId

String getId()
Returns the identifier for this parameter.

Returns:
The identifier; never null.

getName

String getName()
Returns the human-readable name for this parameter.

Returns:
The parameter name; never null.

getValues

IParameterValues getValues()
                           throws 
ParameterValuesException
Returns the values associated with this parameter.

Returns:
The values associated with this parameter. This must not be null.
Throws:
ParameterValuesException - If the values can't be retrieved for some reason.

isOptional

boolean isOptional()
Returns whether parameter is optional. Otherwise, it is required.

Returns:
true if the parameter is optional; false if it is required.

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire