org.eclipse.jdt.internal.compiler
Class ConfigurableOption

java.lang.Object
  org.eclipse.jdt.internal.compiler.ConfigurableOption

public class ConfigurableOption
extends java.lang.Object

Field Summary

static java.lang.String[]

NoDiscreteValue

Constructor Summary

ConfigurableOption(java.lang.String componentName, java.lang.String optionName, java.util.Locale loc, int currentValueIndex)
INTERNAL USE ONLY Initialize an instance of this class according to a specific locale

Method Summary

java.lang.String	getCategory() Return a String that represents the localized category of the receiver.
java.lang.String	getComponentName() Return a String that identifies the component owner (typically the qualified type name of the class which it corresponds to).
int	getCurrentValueIndex() Answer the index (in possibleValues array) of the current setting for this particular option.
java.lang.String	getDescription() Return an String that represents the localized description of the receiver.
int	getID() Internal ID which allows the configurable component to identify this particular option.
java.lang.String	getName() Return a String that represents the localized name of the receiver.
java.lang.String	getOptionName() Gets the optionName.
java.lang.String[]	getPossibleValues() Return an array of String that represents the localized possible values of the receiver.
void	setValueIndex(int newIndex) Change the index (in possibleValues array) of the current setting for this particular option.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NoDiscreteValue

public static final java.lang.String[] NoDiscreteValue

Constructor Detail

ConfigurableOption

public ConfigurableOption(java.lang.String componentName,
                          java.lang.String optionName,
                          java.util.Locale loc,
                          int currentValueIndex)

INTERNAL USE ONLY Initialize an instance of this class according to a specific locale

Parameters:

loc - java.util.Locale

Method Detail

getCategory

public java.lang.String getCategory()

Return a String that represents the localized category of the receiver.

Returns:

java.lang.String

getComponentName

public java.lang.String getComponentName()

Return a String that identifies the component owner (typically the qualified type name of the class which it corresponds to). e.g. "org.eclipse.jdt.internal.compiler.api.Compiler"

Returns:

java.lang.String

getCurrentValueIndex

public int getCurrentValueIndex()

Answer the index (in possibleValues array) of the current setting for this particular option. In case the set of possibleValues is NoDiscreteValue, then this index is the actual value (e.g. max line lenght set to 80).

Returns:

int

getDescription

public java.lang.String getDescription()

Return an String that represents the localized description of the receiver.

Returns:

java.lang.String

getID

public int getID()

Internal ID which allows the configurable component to identify this particular option.

Returns:

int

getName

public java.lang.String getName()

Return a String that represents the localized name of the receiver.

Returns:

java.lang.String

getPossibleValues

public java.lang.String[] getPossibleValues()

Return an array of String that represents the localized possible values of the receiver.

Returns:

java.lang.String[]

setValueIndex

public void setValueIndex(int newIndex)

Change the index (in possibleValues array) of the current setting for this particular option. In case the set of possibleValues is NoDiscreteValue, then this index is the actual value (e.g. max line lenght set to 80).

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getOptionName

public java.lang.String getOptionName()

Gets the optionName.

Returns:

Returns a String