|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IOption
Field Summary | |
---|---|
static java.lang.String |
ALL
|
static java.lang.String |
APPLICABILITY_CALCULATOR
|
static int |
BOOLEAN
|
static int |
BROWSE_DIR
|
static int |
BROWSE_FILE
|
static int |
BROWSE_NONE
|
static java.lang.String |
BROWSE_TYPE
|
static java.lang.String |
CATEGORY
|
static java.lang.String |
COMMAND
|
static java.lang.String |
COMMAND_FALSE
|
static java.lang.String |
DEFAULT_VALUE
|
static java.lang.String |
DIR
|
static java.lang.String |
ENUM_VALUE
|
static int |
ENUMERATED
|
static java.lang.String |
FILE
|
static int |
FILTER_ALL
|
static int |
FILTER_FILE
|
static int |
FILTER_PROJECT
|
static int |
INCLUDE_FILES
|
static int |
INCLUDE_PATH
|
static java.lang.String |
IS_DEFAULT
|
static int |
LIBRARIES
|
static int |
LIBRARY_FILES
|
static int |
LIBRARY_PATHS
|
static java.lang.String |
LIST_ITEM_BUILTIN
|
static java.lang.String |
LIST_ITEM_VALUE
|
static java.lang.String |
LIST_VALUE
|
static int |
MACRO_FILES
|
static java.lang.String |
NONE
|
static int |
OBJECTS
|
static int |
PREPROCESSOR_SYMBOLS
|
static java.lang.String |
PROJECT
|
static java.lang.String |
RESOURCE_FILTER
|
static int |
STRING
|
static int |
STRING_LIST
|
static java.lang.String |
TOOL_TIP
|
static java.lang.String |
TYPE_BOOL
|
static java.lang.String |
TYPE_DEFINED_SYMBOLS
|
static java.lang.String |
TYPE_ENUM
|
static java.lang.String |
TYPE_INC_FILES
|
static java.lang.String |
TYPE_INC_PATH
|
static java.lang.String |
TYPE_LIB
|
static java.lang.String |
TYPE_LIB_FILES
|
static java.lang.String |
TYPE_LIB_PATHS
|
static java.lang.String |
TYPE_STR_LIST
|
static java.lang.String |
TYPE_STRING
|
static java.lang.String |
TYPE_SYMBOL_FILES
|
static java.lang.String |
TYPE_UNDEF_DEFINED_SYMBOLS
|
static java.lang.String |
TYPE_UNDEF_INC_FILES
|
static java.lang.String |
TYPE_UNDEF_INC_PATH
|
static java.lang.String |
TYPE_UNDEF_LIB_FILES
|
static java.lang.String |
TYPE_UNDEF_LIB_PATHS
|
static java.lang.String |
TYPE_UNDEF_SYMBOL_FILES
|
static java.lang.String |
TYPE_USER_OBJS
|
static int |
UNDEF_INCLUDE_FILES
|
static int |
UNDEF_INCLUDE_PATH
|
static int |
UNDEF_LIBRARY_FILES
|
static int |
UNDEF_LIBRARY_PATHS
|
static int |
UNDEF_MACRO_FILES
|
static int |
UNDEF_PREPROCESSOR_SYMBOLS
|
static java.lang.String |
VALUE
|
static java.lang.String |
VALUE_HANDLER
|
static java.lang.String |
VALUE_HANDLER_EXTRA_ARGUMENT
|
static java.lang.String |
VALUE_TYPE
|
Fields inherited from interface org.eclipse.cdt.managedbuilder.core.IBuildObject |
---|
ID, NAME |
Method Summary | |
---|---|
IOptionApplicability |
getApplicabilityCalculator()
|
java.lang.String[] |
getApplicableValues()
If this option is defined as an enumeration, this function returns the list of possible values for that enum. |
java.lang.String[] |
getBasicStringListValue()
in case the option basic value type is STRING_LIST, returns the String list value, throws BuildException otherwise |
OptionStringValue[] |
getBasicStringListValueElements()
|
int |
getBasicValueType()
Returns the type of the option value, i.e. whether it is string, boolean, string list or enumenration. |
boolean |
getBooleanValue()
Answers the value for a boolean option. |
int |
getBrowseType()
Returns the setting of the browseType attribute |
java.lang.String[] |
getBuiltIns()
Answers an array of strings containing the built-in values defined for a stringList, includePaths, definedSymbols, or libs option. |
IOptionCategory |
getCategory()
Returns the category for this option. |
java.lang.String |
getCommand()
Answers a String containing the actual command line
option associated with the option |
java.lang.String |
getCommandFalse()
Answers a String containing the actual command line
option associated with a Boolean option when the value is False |
java.lang.Object |
getDefaultValue()
Returns the raw default value of this option. |
java.lang.String[] |
getDefinedSymbols()
Answers the user-defined preprocessor symbols. |
java.lang.String |
getEnumCommand(java.lang.String id)
Answers the command associated with the enumeration id. |
java.lang.String |
getEnumeratedId(java.lang.String name)
|
java.lang.String |
getEnumName(java.lang.String id)
Answers the "name" associated with the enumeration id. |
java.lang.String[] |
getIncludePaths()
Answers an array of String containing the includes paths
defined in the build model. |
java.lang.String[] |
getLibraries()
Answers an array or String s containing the libraries
that must be linked into the project. |
IHoldsOptions |
getOptionHolder()
Returns the holder (parent) of this option. |
IBuildObject |
getParent()
Returns the parent of this option. |
int |
getResourceFilter()
Returns the setting of the resourceFilter attribute |
java.lang.String |
getSelectedEnum()
Answers a String containing the unique ID of the selected
enumeration in an enumerated option. |
java.lang.String[] |
getStringListValue()
Returns the current value for this option if it is a List of Strings. |
java.lang.String |
getStringValue()
Returns the current value for this option if it is a String |
IOption |
getSuperClass()
Returns the IOption that is the superclass of this
option, or null if the attribute was not specified. |
java.lang.String |
getToolTip()
Answers a String containing the tooltip
associated with the option |
java.lang.String[] |
getUserObjects()
Answers all of the user-defined object files that must be linked with the final build target. |
java.lang.Object |
getValue()
Returns the raw value of this option. |
IManagedOptionValueHandler |
getValueHandler()
Returns the value handler specified for this tool. |
java.lang.String |
getValueHandlerExtraArgument()
Returns the value handlers extra argument specified for this tool |
int |
getValueType()
Get the type for the value of the option. |
boolean |
isExtensionElement()
Returns true if this option was loaded from a manifest file,
and false if it was loaded from a project (.cdtbuild) file. |
boolean |
isValid()
Returns true if this option is valid and false
if the option cannot be safely used due to an error in the MBS grammar. |
boolean |
overridesOnlyValue()
Deprecated. |
void |
setBrowseType(int type)
Sets the browseType attribute. |
void |
setCategory(IOptionCategory category)
Sets the category for this option. |
void |
setCommand(java.lang.String command)
Sets a String containing the actual command line
option associated with the option |
void |
setCommandFalse(java.lang.String commandFalse)
Sets a String containing the actual command line
option associated with a Boolean option when the value is False |
void |
setDefaultValue(java.lang.Object v)
Sets the default value of this option. |
void |
setResourceFilter(int filter)
Sets the resourceFilter attribute. |
void |
setToolTip(java.lang.String tooltip)
Sets a String containing the tooltip
associated with the option |
void |
setValue(boolean value)
Sets the boolean value of the receiver to the value specified in the argument. |
void |
setValue(java.lang.Object v)
Sets the raw value of this option. |
void |
setValue(java.lang.String value)
Sets the string value of the receiver to the value specified in the argument. |
void |
setValue(java.lang.String[] value)
Sets the value of the receiver to be an array of strings. |
void |
setValueHandlerExtraArgument(java.lang.String extraArgument)
Sets the value handlers extra argument specified for this tool |
void |
setValueType(int type)
Sets the value-type of this option. |
Methods inherited from interface org.eclipse.cdt.managedbuilder.core.IBuildObject |
---|
getBaseId, getId, getManagedBuildRevision, getName, getVersion, setVersion |
Field Detail |
---|
static final int BOOLEAN
static final int ENUMERATED
static final int STRING
static final int STRING_LIST
static final int INCLUDE_PATH
static final int PREPROCESSOR_SYMBOLS
static final int LIBRARIES
static final int OBJECTS
static final int INCLUDE_FILES
static final int LIBRARY_PATHS
static final int LIBRARY_FILES
static final int MACRO_FILES
static final int UNDEF_INCLUDE_PATH
static final int UNDEF_PREPROCESSOR_SYMBOLS
static final int UNDEF_INCLUDE_FILES
static final int UNDEF_LIBRARY_PATHS
static final int UNDEF_LIBRARY_FILES
static final int UNDEF_MACRO_FILES
static final int BROWSE_NONE
static final java.lang.String NONE
static final int BROWSE_FILE
static final java.lang.String FILE
static final int BROWSE_DIR
static final java.lang.String DIR
static final int FILTER_ALL
static final java.lang.String ALL
static final int FILTER_FILE
static final int FILTER_PROJECT
static final java.lang.String PROJECT
static final java.lang.String BROWSE_TYPE
static final java.lang.String CATEGORY
static final java.lang.String COMMAND
static final java.lang.String COMMAND_FALSE
static final java.lang.String TOOL_TIP
static final java.lang.String DEFAULT_VALUE
static final java.lang.String ENUM_VALUE
static final java.lang.String IS_DEFAULT
static final java.lang.String LIST_VALUE
static final java.lang.String RESOURCE_FILTER
static final java.lang.String APPLICABILITY_CALCULATOR
static final java.lang.String TYPE_BOOL
static final java.lang.String TYPE_ENUM
static final java.lang.String TYPE_INC_PATH
static final java.lang.String TYPE_LIB
static final java.lang.String TYPE_STRING
static final java.lang.String TYPE_STR_LIST
static final java.lang.String TYPE_USER_OBJS
static final java.lang.String TYPE_DEFINED_SYMBOLS
static final java.lang.String TYPE_LIB_PATHS
static final java.lang.String TYPE_LIB_FILES
static final java.lang.String TYPE_INC_FILES
static final java.lang.String TYPE_SYMBOL_FILES
static final java.lang.String TYPE_UNDEF_INC_PATH
static final java.lang.String TYPE_UNDEF_DEFINED_SYMBOLS
static final java.lang.String TYPE_UNDEF_LIB_PATHS
static final java.lang.String TYPE_UNDEF_LIB_FILES
static final java.lang.String TYPE_UNDEF_INC_FILES
static final java.lang.String TYPE_UNDEF_SYMBOL_FILES
static final java.lang.String VALUE
static final java.lang.String VALUE_TYPE
static final java.lang.String VALUE_HANDLER
static final java.lang.String VALUE_HANDLER_EXTRA_ARGUMENT
static final java.lang.String LIST_ITEM_VALUE
static final java.lang.String LIST_ITEM_BUILTIN
Method Detail |
---|
IBuildObject getParent()
IHoldsOptions getOptionHolder()
IOption getSuperClass()
IOption
that is the superclass of this
option, or null
if the attribute was not specified.
java.lang.String[] getApplicableValues()
null
.
boolean getBooleanValue() throws BuildException
BuildException
int getBrowseType()
void setBrowseType(int type)
int
- int getResourceFilter()
void setResourceFilter(int filter)
int
- IOptionApplicability getApplicabilityCalculator()
java.lang.String[] getBuiltIns()
null
.
IOptionCategory getCategory()
void setCategory(IOptionCategory category)
IOptionCategory
- java.lang.String getCommand()
String
containing the actual command line
option associated with the option
void setCommand(java.lang.String command)
String
containing the actual command line
option associated with the option
String
- java.lang.String getCommandFalse()
String
containing the actual command line
option associated with a Boolean option when the value is False
void setCommandFalse(java.lang.String commandFalse)
String
containing the actual command line
option associated with a Boolean option when the value is False
String
- java.lang.String getToolTip()
String
containing the tooltip
associated with the option
void setToolTip(java.lang.String tooltip)
String
containing the tooltip
associated with the option
String
- java.lang.String[] getDefinedSymbols() throws BuildException
BuildException
java.lang.String getEnumCommand(java.lang.String id) throws BuildException
gnu.debug.level.default
for the debug level option of the Gnu compiler, and the plugin
manifest defined that as -g, then the return value would be the
String "-g"
BuildException
java.lang.String getEnumName(java.lang.String id) throws BuildException
BuildException
java.lang.String getEnumeratedId(java.lang.String name) throws BuildException
name
-
BuildException
java.lang.String[] getIncludePaths() throws BuildException
String
containing the includes paths
defined in the build model.
BuildException
java.lang.String[] getLibraries() throws BuildException
String
s containing the libraries
that must be linked into the project.
BuildException
java.lang.String getSelectedEnum() throws BuildException
String
containing the unique ID of the selected
enumeration in an enumerated option. For an option that has not been
changed by the user, the receiver will answer with the default defined
in the plugin manifest. If the user has modified the selection, the
receiver will answer with the overridden selection.
BuildException
- if the option type is not an enumerationjava.lang.String[] getStringListValue() throws BuildException
BuildException
java.lang.String getStringValue() throws BuildException
BuildException
java.lang.String[] getUserObjects() throws BuildException
BuildException
java.lang.Object getValue()
java.lang.Object getDefaultValue()
int getValueType() throws BuildException
BuildException
void setValue(boolean value) throws BuildException
value
-
BuildException
void setValue(java.lang.String value) throws BuildException
value
-
BuildException
void setValue(java.lang.String[] value) throws BuildException
value
- An array of strings to place in the option reference.
BuildException
void setValue(java.lang.Object v)
v
- The Object that contains the raw value of the option. The type
of Object is specific to the option type.void setDefaultValue(java.lang.Object v)
v
- The Object that contains the default value of the option. The type
of Object is specific to the option type.void setValueType(int type)
type
- IManagedOptionValueHandler getValueHandler()
java.lang.String getValueHandlerExtraArgument()
void setValueHandlerExtraArgument(java.lang.String extraArgument)
extraArgument
- boolean isExtensionElement()
true
if this option was loaded from a manifest file,
and false
if it was loaded from a project (.cdtbuild) file.
boolean overridesOnlyValue()
true
if this option only oveerides the value attribute
of its superclass and false
if it overrides other attributes.
boolean isValid()
true
if this option is valid and false
if the option cannot be safely used due to an error in the MBS grammar.
int getBasicValueType() throws BuildException
BuildException
java.lang.String[] getBasicStringListValue() throws BuildException
BuildException
OptionStringValue[] getBasicStringListValueElements() throws BuildException
BuildException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |