public interface ICommand
Changes to a command will only take effect if the modified command is installed
into a project description via IProjectDescription.setBuildSpec(ICommand[])
.
IProjectDescription
Modifier and Type | Method and Description |
---|---|
Map<String,String> |
getArguments()
Returns a table of the arguments for this command, or
null
if there are no arguments. |
String |
getBuilderName()
Returns the name of the builder to run for this command, or
null if the name has not been set. |
boolean |
isBuilding(int kind)
Returns whether this build command responds to the given kind of build.
|
boolean |
isConfigurable()
Returns whether this command allows configuring of what kinds of builds
it responds to.
|
void |
setArguments(Map<String,String> args)
Sets this command's arguments to be the given table of name-values
pairs, or to
null if there are no arguments. |
void |
setBuilderName(String builderName)
Sets the name of the builder to run for this command.
|
void |
setBuilding(int kind,
boolean value)
Specifies whether this build command responds to the provided kind of build.
|
Map<String,String> getArguments()
null
if there are no arguments. The argument names and values are both strings.String
value type : String
), or null
setArguments(Map)
String getBuilderName()
null
if the name has not been set.null
if not setsetBuilderName(String)
boolean isBuilding(int kind)
By default, build commands respond to all kinds of builds.
kind
- One of the *_BUILD constants defined
on IncrementalProjectBuilder
true
if this build command responds to the specified
kind of build, and false
otherwise.setBuilding(int, boolean)
boolean isConfigurable()
isConfigurable()
attribute in its builder extension declaration. A command that is not
configurable will always respond to all kinds of builds.true
If this command allows configuration of
what kinds of builds it responds to, and false
otherwise.setBuilding(int, boolean)
void setArguments(Map<String,String> args)
null
if there are no arguments. The argument
names and values are both strings.
Individual builders specify their argument expectations.
Note that modifications to the arguments of a command
being used in a running builder may affect the run of that builder
but will not affect any subsequent runs. To change a command
permanently you must install the command into the relevant project
build spec using IProjectDescription.setBuildSpec(ICommand[])
.
args
- a table of command arguments (keys and values must
both be of type String
), or null
getArguments()
void setBuilderName(String builderName)
The builder name comes from the extension that plugs in
to the standard org.eclipse.core.resources.builders
extension point.
builderName
- the name of the buildergetBuilderName()
void setBuilding(int kind, boolean value)
When a command is configured to not respond to a given kind of build, the builder instance will not be called when a build of that kind is initiated.
This method has no effect if this build command does not allow its build kinds to be configured.
Note:
kind
- One of the *_BUILD constants defined
on IncrementalProjectBuilder
value
- true
if this build command responds to the
specified kind of build, and false
otherwise.isBuilding(int)
,
isConfigurable()
,
IWorkspace.build(int, IProgressMonitor)
,
IProject.build(int, IProgressMonitor)
,
IncrementalProjectBuilder.FULL_BUILD
,
IncrementalProjectBuilder.INCREMENTAL_BUILD
,
IncrementalProjectBuilder.AUTO_BUILD
,
IncrementalProjectBuilder.CLEAN_BUILD
Copyright (c) 2000, 2016 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.