Eclipse Plug-in Developer Guide (Galileo) - Parameterization (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.core.commands
Class Parameterization


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

public final class Parameterization
extends Object
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.