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
Class Parameterization

java.lang.Object
  extended by 
org.eclipse.core.commands.Parameterization

public final class Parameterization
extends Object

A parameter with a specific value. This is usually a part of a ParameterizedCommand, which is used to refer to a command with a collection of parameterizations.

Since:
3.1

Constructor Summary
Parameterization ( IParameter parameter, String value)
          Constructs a new instance of Parameterization.
 
Method Summary
 boolean equals ( Object object)
           
  IParameter getParameter ()
          Returns the parameter that is being parameterized.
  String getValue ()
          Returns the value for the parameter in this parameterization.
  String getValueName ()
          Returns the human-readable name for the current value, if any.
 int hashCode ()
           
 
Methods inherited from class java.lang. Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Parameterization

public Parameterization(
IParameter parameter,
                        
String value)
Constructs a new instance of Parameterization.

Parameters:
parameter - The parameter that is being parameterized; must not be null.
value - The value for the parameter; may be null.
Method Detail

equals

public final boolean equals(
Object object)
Overrides:
equals in class Object

getParameter

public final 
IParameter getParameter()
Returns the parameter that is being parameterized.

Returns:
The parameter; never null.

getValue

public final 
String getValue()
Returns the value for the parameter in this parameterization.

Returns:
The value; may be null.

getValueName

public final 
String getValueName()
                          throws 
ParameterValuesException
Returns the human-readable name for the current value, if any. If the name cannot be found, then it simply returns the value. It also ensures that any null values are converted into an empty string.

Returns:
The human-readable name of the value; never null.
Throws:
ParameterValuesException - If the parameter needed to be initialized, but couldn't be.

hashCode

public final int hashCode()
Overrides:
hashCode in class Object

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