org.eclipse.cdt.managedbuilder.core
Interface ITarget

All Superinterfaces:
IBuildObject
All Known Implementing Classes:
Target

public interface ITarget
extends IBuildObject

This class represents targets for the managed build process. A target is some type of resource built using a given collection of tools. Note: This class was deprecated in 2.1


Field Summary
static java.lang.String ARCH_LIST
           
static java.lang.String ARTIFACT_NAME
           
static java.lang.String BINARY_PARSER
           
static java.lang.String CLEAN_COMMAND
           
static java.lang.String DEFAULT_EXTENSION
           
static java.lang.String ERROR_PARSERS
           
static java.lang.String EXTENSION
           
static java.lang.String IS_ABSTRACT
           
static java.lang.String IS_TEST
           
static java.lang.String MAKE_ARGS
           
static java.lang.String MAKE_COMMAND
           
static java.lang.String OS_LIST
           
static java.lang.String PARENT
           
static java.lang.String SCANNER_INFO_COLLECTOR_ID
           
static java.lang.String TARGET_ELEMENT_NAME
           
 
Fields inherited from interface org.eclipse.cdt.managedbuilder.core.IBuildObject
ID, NAME
 
Method Summary
 void convertToProjectType(java.lang.String managedBuildRevision)
          Converts a CDT V2.0 target into a ProjectType + Configuration + Toolchain + Builder + TargetPlatform.
 IConfigurationV2 createConfiguration(IConfigurationV2 parent, java.lang.String id)
          Creates a configuration for the target populated with the tools and options settings from the parent configuration.
 IConfigurationV2 createConfiguration(java.lang.String id)
          Creates a new configuration for the target.
 java.lang.String getArtifactExtension()
          Answers the extension that should be applied to build artifacts created by this target.
 java.lang.String getArtifactName()
          Get the name of the final build artifact.
 java.lang.String getBinaryParserId()
          Answers the unique ID of the binary parser associated with the target.
 java.lang.String getCleanCommand()
          Answers the OS-specific command to remove files created by the build
 IConfigurationV2 getConfiguration(java.lang.String id)
          Returns the configuration with the given id, or null if not found.
 IConfigurationV2[] getConfigurations()
          Returns all of the configurations defined by this target.
 ProjectType getCreatedProjectType()
          Returns the ProjectType that this Target has been converted to, or null if it has not been converted.
 java.lang.String getDefaultExtension()
          Deprecated.  
 java.lang.String getErrorParserIds()
          Answers the semicolon separated list of unique IDs of the error parsers associated with the target.
 java.lang.String[] getErrorParserList()
          Answers the ordered list of unique IDs of the error parsers associated with the target.
 java.lang.String getMakeArguments()
          Answers the command line arguments to pass to the make utility used by the receiver to build a project.
 java.lang.String getMakeCommand()
          Answers the name of the make utility for the target.
 org.eclipse.core.resources.IResource getOwner()
          Gets the resource that this target is applied to.
 ITarget getParent()
          Answers the ITarget that is the parent of the receiver.
 java.lang.String[] getTargetArchList()
          Answers an array of architectures the target can be created on.
 java.lang.String[] getTargetOSList()
          Answers an array of operating systems the target can be created on.
 ITool getTool(java.lang.String id)
          Answers the tool in the receiver with the ID specified in the argument, or null
 ITool[] getTools()
          Returns the list of platform specific tools associated with this platform.
 boolean hasOverridenMakeCommand()
          Answers true if the receiver has a make command that differs from its parent specification.
 boolean isAbstract()
          Returns whether this target is abstract.
 boolean isDirty()
          Answers true the receiver has changes that need to be saved in the project file, else false.
 boolean isTestTarget()
          Answers true if the receiver is a target that is defined for testing purposes only, else false.
 boolean needsRebuild()
          Answers whether the receiver has been changed and requires the project to be rebuilt.
 void removeConfiguration(java.lang.String id)
          Removes the configuration with the ID specified in the argument.
 void setArtifactExtension(java.lang.String extension)
          Set (override) the extension that should be appended to the build artifact for the receiver.
 void setArtifactName(java.lang.String name)
          Set the name of the artifact that will be produced when the receiver is built.
 void setDirty(boolean isDirty)
           
 void setErrorParserIds(java.lang.String ids)
          Sets the semicolon separated list of error parser ids
 void setMakeArguments(java.lang.String makeArgs)
          Sets the arguments to be passed to the make utility used by the receiver to produce a build goal.
 void setMakeCommand(java.lang.String command)
          Sets the make command for the receiver to the value in the argument.
 void setRebuildState(boolean rebuild)
          Set the rebuild state of the receiver.
 void updateOwner(org.eclipse.core.resources.IResource resource)
          Sets the resource that owns the receiver.
 
Methods inherited from interface org.eclipse.cdt.managedbuilder.core.IBuildObject
getBaseId, getId, getManagedBuildRevision, getName, getVersion, setVersion
 

Field Detail

TARGET_ELEMENT_NAME

static final java.lang.String TARGET_ELEMENT_NAME
See Also:
Constant Field Values

ARTIFACT_NAME

static final java.lang.String ARTIFACT_NAME
See Also:
Constant Field Values

BINARY_PARSER

static final java.lang.String BINARY_PARSER
See Also:
Constant Field Values

ERROR_PARSERS

static final java.lang.String ERROR_PARSERS
See Also:
Constant Field Values

CLEAN_COMMAND

static final java.lang.String CLEAN_COMMAND
See Also:
Constant Field Values

DEFAULT_EXTENSION

static final java.lang.String DEFAULT_EXTENSION
See Also:
Constant Field Values

EXTENSION

static final java.lang.String EXTENSION
See Also:
Constant Field Values

IS_ABSTRACT

static final java.lang.String IS_ABSTRACT
See Also:
Constant Field Values

IS_TEST

static final java.lang.String IS_TEST
See Also:
Constant Field Values

MAKE_COMMAND

static final java.lang.String MAKE_COMMAND
See Also:
Constant Field Values

MAKE_ARGS

static final java.lang.String MAKE_ARGS
See Also:
Constant Field Values

OS_LIST

static final java.lang.String OS_LIST
See Also:
Constant Field Values

ARCH_LIST

static final java.lang.String ARCH_LIST
See Also:
Constant Field Values

PARENT

static final java.lang.String PARENT
See Also:
Constant Field Values

SCANNER_INFO_COLLECTOR_ID

static final java.lang.String SCANNER_INFO_COLLECTOR_ID
See Also:
Constant Field Values
Method Detail

createConfiguration

IConfigurationV2 createConfiguration(IConfigurationV2 parent,
                                     java.lang.String id)
Creates a configuration for the target populated with the tools and options settings from the parent configuration. As options and tools change in the parent, unoverridden values are updated in the child config as well.

Parameters:
parent - The IConfigurationV2 to use as a settings template
id - The unique id the new configuration will have
Returns:
IConfigurationV2

createConfiguration

IConfigurationV2 createConfiguration(java.lang.String id)
Creates a new configuration for the target. It is populated with the tools defined for that target and options set at their defaults.

Parameters:
id - id for this configuration.
Returns:
IConfigurationV2

getArtifactExtension

java.lang.String getArtifactExtension()
Answers the extension that should be applied to build artifacts created by this target.

Returns:
String

getArtifactName

java.lang.String getArtifactName()
Get the name of the final build artifact.

Returns:
String

setDirty

void setDirty(boolean isDirty)
Parameters:
isDirty -

getBinaryParserId

java.lang.String getBinaryParserId()
Answers the unique ID of the binary parser associated with the target.

Returns:
String

getErrorParserIds

java.lang.String getErrorParserIds()
Answers the semicolon separated list of unique IDs of the error parsers associated with the target.

Returns:
String

getErrorParserList

java.lang.String[] getErrorParserList()
Answers the ordered list of unique IDs of the error parsers associated with the target.

Returns:
String[]

getCleanCommand

java.lang.String getCleanCommand()
Answers the OS-specific command to remove files created by the build

Returns:
String

getConfigurations

IConfigurationV2[] getConfigurations()
Returns all of the configurations defined by this target.

Returns:
IConfigurationV2[]

getDefaultExtension

java.lang.String getDefaultExtension()
Deprecated. 

Get the default extension that should be applied to build artifacts created by this target.

Returns:
String

getMakeArguments

java.lang.String getMakeArguments()
Answers the command line arguments to pass to the make utility used by the receiver to build a project.

Returns:

getMakeCommand

java.lang.String getMakeCommand()
Answers the name of the make utility for the target.

Returns:
String

getConfiguration

IConfigurationV2 getConfiguration(java.lang.String id)
Returns the configuration with the given id, or null if not found.

Parameters:
id -
Returns:
IConfigurationV2

getOwner

org.eclipse.core.resources.IResource getOwner()
Gets the resource that this target is applied to.

Returns:
IResource

getParent

ITarget getParent()
Answers the ITarget that is the parent of the receiver.

Returns:
ITarget

getTargetOSList

java.lang.String[] getTargetOSList()
Answers an array of operating systems the target can be created on.

Returns:
String[]

getTargetArchList

java.lang.String[] getTargetArchList()
Answers an array of architectures the target can be created on.

Returns:
String[]

getTools

ITool[] getTools()
Returns the list of platform specific tools associated with this platform.

Returns:
ITool[]

getTool

ITool getTool(java.lang.String id)
Answers the tool in the receiver with the ID specified in the argument, or null

Parameters:
id -
Returns:

hasOverridenMakeCommand

boolean hasOverridenMakeCommand()
Answers true if the receiver has a make command that differs from its parent specification.

Returns:
boolean

isAbstract

boolean isAbstract()
Returns whether this target is abstract.

Returns:
boolean

isDirty

boolean isDirty()
Answers true the receiver has changes that need to be saved in the project file, else false.

Returns:
boolean

isTestTarget

boolean isTestTarget()
Answers true if the receiver is a target that is defined for testing purposes only, else false. A test target will not be shown in the UI but can still be manipulated programmatically.

Returns:
boolean

needsRebuild

boolean needsRebuild()
Answers whether the receiver has been changed and requires the project to be rebuilt.

Returns:
true if the receiver contains a change that needs the project to be rebuilt

removeConfiguration

void removeConfiguration(java.lang.String id)
Removes the configuration with the ID specified in the argument.

Parameters:
id -

setArtifactExtension

void setArtifactExtension(java.lang.String extension)
Set (override) the extension that should be appended to the build artifact for the receiver.

Parameters:
extension -

setArtifactName

void setArtifactName(java.lang.String name)
Set the name of the artifact that will be produced when the receiver is built.

Parameters:
name -

setMakeArguments

void setMakeArguments(java.lang.String makeArgs)
Sets the arguments to be passed to the make utility used by the receiver to produce a build goal.

Parameters:
makeArgs -

setMakeCommand

void setMakeCommand(java.lang.String command)
Sets the make command for the receiver to the value in the argument.

Parameters:
command -

setErrorParserIds

void setErrorParserIds(java.lang.String ids)
Sets the semicolon separated list of error parser ids

Parameters:
ids -

setRebuildState

void setRebuildState(boolean rebuild)
Set the rebuild state of the receiver.

Parameters:
true - will force a rebuild the next time the project builds
See Also:
IManagedBuildInfo.setRebuildState(boolean)

updateOwner

void updateOwner(org.eclipse.core.resources.IResource resource)
Sets the resource that owns the receiver.

Parameters:
resource -

convertToProjectType

void convertToProjectType(java.lang.String managedBuildRevision)
Converts a CDT V2.0 target into a ProjectType + Configuration + Toolchain + Builder + TargetPlatform.

Parameters:
managedBuildRevision -

getCreatedProjectType

ProjectType getCreatedProjectType()
Returns the ProjectType that this Target has been converted to, or null if it has not been converted.

Returns:
ProjectType