|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IHoldsOptions
Implements the functionality that is needed to hold options and option categories. The functionality has been moved from ITool to here in CDT 3.0. Backwards compatibility of interfaces has been maintained because ITool extends IHoldOptions.
Field Summary | |
---|---|
static java.lang.String |
OPTION
|
static java.lang.String |
OPTION_CAT
|
static java.lang.String |
OPTION_REF
|
Fields inherited from interface org.eclipse.cdt.managedbuilder.core.IBuildObject |
---|
ID, NAME |
Method Summary | |
---|---|
void |
addOptionCategory(IOptionCategory category)
Adds the IOptionCategory to this Option Holder's
list of Option Categories. |
IOption |
createOption(IOption superClass,
java.lang.String Id,
java.lang.String name,
boolean isExtensionElement)
Creates a child Option |
void |
createOptions(IHoldsOptions superClass)
Creates options from the superclass and adds it to this class. |
IOptionCategory[] |
getChildCategories()
Returns the option category children of this tool. |
IOption |
getOption(java.lang.String id)
Deprecated. use getOptionById() instead |
IOption |
getOptionById(java.lang.String id)
Get the IOption in the receiver with the specified
ID. |
IOption |
getOptionBySuperClassId(java.lang.String id)
Get the IOption in the receiver with the specified
ID, or an option with a superclass with this id. |
IOptionCategory |
getOptionCategory(java.lang.String id)
Answers the IOptionCategory that has the unique identifier
specified in the argument. |
IOption[] |
getOptions()
Returns the complete list of options that are available for this object. |
IOption |
getOptionToSet(IOption option,
boolean adjustExtension)
This method should be called in order to obtain the option whose value and attributes could be directly changed/adjusted |
boolean |
needsRebuild()
specifies whether the option holder is modified and needs rebuild |
void |
removeOption(IOption option)
Removes an option. |
void |
setRebuildState(boolean rebuild)
sets the holder rebuild state |
Methods inherited from interface org.eclipse.cdt.managedbuilder.core.IBuildObject |
---|
getBaseId, getId, getManagedBuildRevision, getName, getVersion, setVersion |
Field Detail |
---|
static final java.lang.String OPTION
static final java.lang.String OPTION_CAT
static final java.lang.String OPTION_REF
Method Detail |
---|
IOption createOption(IOption superClass, java.lang.String Id, java.lang.String name, boolean isExtensionElement)
Option
- The superClass, if anyString
- The id for the new optionString
- The name for the new optionboolean
- Indicates whether this is an extension element or a managed project element
void removeOption(IOption option)
option
- IOption getOption(java.lang.String id)
IOption
from
the receiver based on an ID. It is preferred that you use the newer method
getOptionById
id
- unique identifier of the option to search for
IOption
org.eclipse.cdt.core.build.managed.IHoldsOptions#getOptionById(java.lang.String)
IOption getOptionById(java.lang.String id)
IOption
in the receiver with the specified
ID. This is an efficient search in the receiver.
If the receiver does not have an option with that ID, the method
returns null
. It is the responsibility of the caller to
verify the return value.
id
- unique identifier of the option to search for
IOption
IOption getOptionBySuperClassId(java.lang.String id)
IOption
in the receiver with the specified
ID, or an option with a superclass with this id.
If the receiver does not have an option with that ID, the method
returns null
. It is the responsibility of the caller to
verify the return value.
id
- unique identifier of the option to search for
IOption
IOption[] getOptions()
IOptionCategory[] getChildCategories()
void addOptionCategory(IOptionCategory category)
IOptionCategory
to this Option Holder's
list of Option Categories.
category
- The option category to be addedIOptionCategory getOptionCategory(java.lang.String id)
IOptionCategory
that has the unique identifier
specified in the argument.
id
- The unique identifier of the option category
IOptionCategory
with the id specified in the argumentvoid createOptions(IHoldsOptions superClass)
IHoldsOptions
- The superClassIOption getOptionToSet(IOption option, boolean adjustExtension) throws BuildException
id
- -the option to be modifiedadjustExtension
- - if false, modifications are to be made for the non-extension element
(only for some particular configuration associated with some eclipse project)
This is the most common use of this method.
True is allowed only while while handling the LOAD value handler event.
In this case modifications are to be made for the extension element.
This could be used for adjusting extension options
Note: changing this option will affect all non-extension configurations using this option!
BuildException
boolean needsRebuild()
void setRebuildState(boolean rebuild)
rebuild
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |