org.eclipse.cdt.managedbuilder.core
Interface IInputOrder

All Known Implementing Classes:
InputOrder

public interface IInputOrder

This interface represents an inputOrder instance in the managed build system. This element is only present if the user or a tool integrator needs to define the specific order of input files to a tool, or needs to exclude one or more input files from being used by a tool. An inputType element can have multiple inputOrder children.

Since:
3.0

Field Summary
static java.lang.String EXCLUDED
           
static java.lang.String INPUT_ORDER_ELEMENT_NAME
           
static java.lang.String ORDER
           
static java.lang.String PATH
           
 
Method Summary
 boolean getExcluded()
          Returns true if this resource is not used as an input for the tool.
 java.lang.String getOrder()
          Returns a comma-separated list of integer values that specify the order of this resource.
 IInputType getParent()
          Returns the InputType parent of this InputOrder.
 java.lang.String getPath()
          Returns the relative or absolute path of the resource to which this element applies.
 boolean isDirty()
          Returns true if this element has changes that need to be saved in the project file, else false.
 void setDirty(boolean isDirty)
          Sets the element's "dirty" (have I been modified?)
 void setExcluded(boolean excluded)
          Sets whether this resource is not used as an input for the tool.
 void setOrder(java.lang.String order)
          Sets the comma-separated list of integer values that specify the order of this resource.
 void setPath(java.lang.String path)
          Sets the relative or absolute path of the resource to which this element applies.
 

Field Detail

INPUT_ORDER_ELEMENT_NAME

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

PATH

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

ORDER

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

EXCLUDED

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

getParent

IInputType getParent()
Returns the InputType parent of this InputOrder.

Returns:
IInputType

getPath

java.lang.String getPath()
Returns the relative or absolute path of the resource to which this element applies. The resource must be a member of the project, or the output from another tool in the tool-chain.

Returns:
String

setPath

void setPath(java.lang.String path)
Sets the relative or absolute path of the resource to which this element applies.

Parameters:
path -

getOrder

java.lang.String getOrder()
Returns a comma-separated list of integer values that specify the order of this resource. In most cases, only a single integer value will be specified. A list is supported for the case where a single input file needs to be specified multiple times on the command line. The order numbers begin at 1. Not all values need to be specified. Unordered resources will fill the first "gap". For example: - To specify the first input file, use 1. - To specify the last input file, without specifying an order for any other input file, use 2. - To specify only the first two input files and last input file, use 1, 2 & 4.

Returns:
String

setOrder

void setOrder(java.lang.String order)
Sets the comma-separated list of integer values that specify the order of this resource.

Parameters:
order -

getExcluded

boolean getExcluded()
Returns true if this resource is not used as an input for the tool.

Returns:
boolean

setExcluded

void setExcluded(boolean excluded)
Sets whether this resource is not used as an input for the tool.

Parameters:
excluded -

isDirty

boolean isDirty()
Returns true if this element has changes that need to be saved in the project file, else false.

Returns:
boolean

setDirty

void setDirty(boolean isDirty)
Sets the element's "dirty" (have I been modified?) flag.

Parameters:
isDirty -