com.togethersoft.sca.core
Interface IParameter

All Known Subinterfaces:

IParameterBoolean, IParameterInteger, IParameterList, IParameterReal, IParameterString, IParameterStringEnum

public interface IParameter

Provides common interface for extension, code inspector, and analyzer parameters. The parameters are specified in the plug-in manfiest file plugin.xml.

Field Summary

static int	BOOLEAN Represents a boolean parameter.
static int	INTEGER Represents an integer parameter.
static int	LIST Represents a property parameter.
static int	REAL Represents a floating-point parameter.
static int	STRING Represents a string parameter.
static int	STRING_ENUM Represents a string enumeration parameter.

Method Summary

java.lang.Object	clone() Creates a deep copy of this parameter.
java.lang.String	getId() Returns the unique identifier of this parameter.
java.lang.String	getName() Returns the text description of this parameter.
int	getType() Returns the type of this parameter encoded as integer.
boolean	isRemovable() Indicates whether this parameter can be removed from the parameter registry.

Field Detail

BOOLEAN

public static final int BOOLEAN

Represents a boolean parameter.

INTEGER

public static final int INTEGER

Represents an integer parameter.

LIST

public static final int LIST

Represents a property parameter.

REAL

public static final int REAL

Represents a floating-point parameter.

STRING

public static final int STRING

Represents a string parameter.

STRING_ENUM

public static final int STRING_ENUM

Represents a string enumeration parameter.

Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Creates a deep copy of this parameter.

getId

public java.lang.String getId()

Returns the unique identifier of this parameter.

getName

public java.lang.String getName()

Returns the text description of this parameter.

getType

public int getType()

Returns the type of this parameter encoded as integer.

Returns:

the type of this parameter.

isRemovable

public boolean isRemovable()

Indicates whether this parameter can be removed from the parameter registry.