org.mule.runtime.api.component.location

Interface ComponentLocation

@NoImplement
public interface ComponentLocation

Provides information about the location of a component within an artifact. A component location describes where the component is defined in the configuration of the artifact. For instance:

• COMPONENT_NAME - global component defined with name COMPONENT_NAME
• FLOW_NAME/source - a source defined within a flow
• FLOW_NAME/processors/0 - the first processor defined within a flow with name FLOW_NAME
• FLOW_NAME/processors/4/processors/1 - the second processors defined inside another processor which is positioned fifth within a flow with name FLOW_NAME
• FLOW_NAME/errorHandler/0 - the first on-error within the error handler
• FLOW_NAME/0/errorHandler/3 - the fourth on-error within the error handler of the first element of the flow with name FLOW_NAME

The different LocationParts in FLOW_NAME/processors/1 are:

• 'processors' as partPath and no component identifier since this part is synthetic to indicate the part of the flow referenced by the next index
• '1' as partPath and 'mule:payload' as component identifier assuming that the second processor of the flow was a set-payload component

Since:

1.0

Method Summary

Modifier and Type	Method and Description
OptionalInt	getColumn()
TypedComponentIdentifier	getComponentIdentifier()
Optional<String>	getFileName()
List<URI>	getImportChain() If the component with this location is in a root config file (not obtained through an import tag), the returned list will be empty.
OptionalInt	getLine()
Optional<Integer>	getLineInFile() Deprecated. Use getLine() instead.
String	getLocation()
List<LocationPart>	getParts()
String	getRootContainerName() Gets the name of the root containing element.
Optional<Integer>	getStartColumn() Deprecated. Use getColumn() instead.

Method Detail

getLocation

String getLocation()

Returns:

the unique absolute path of the component in the artifact.

getFileName

Optional<String> getFileName()

Returns:

the config file of the artifact where this component is defined, if it was defined in a config file.

getImportChain

List<URI> getImportChain()

If the component with this location is in a root config file (not obtained through an import tag), the returned list will be empty.

If the component with this location is obtained through an import, the location of the first import will be the first element of the returned list. Any other nested imported locations will be the subsequent elements of the returned list.

Returns:

a List containing an element for every import location leading to the file containing the owning component.

Since:

1.5

getLineInFile

@Deprecated
Optional<Integer> getLineInFile()

Deprecated. Use getLine() instead.

Returns:

the line number in the config file of the artifact where this component is defined, if it was defined in a config file.

getStartColumn

@Deprecated
Optional<Integer> getStartColumn()

Deprecated. Use getColumn() instead.

Returns:

the start column number in the config file of the artifact where this component is defined, is it was defined in a config file.

getLine

OptionalInt getLine()

Returns:

the line number in the config file of the artifact where this component is defined, if it was defined in a config file.

getColumn

OptionalInt getColumn()

Returns:

the start column number in the config file of the artifact where this component is defined, is it was defined in a config file.

getParts

List<LocationPart> getParts()

Returns:

the list of parts for the location. The location starts with the global element containing the component and continues with the next elements within the global element until the last part which is the component specific part.

getComponentIdentifier

TypedComponentIdentifier getComponentIdentifier()

Returns:

the ComponentIdentifier of the component associated with this location

getRootContainerName

String getRootContainerName()

Gets the name of the root containing element.

Returns:

the first part path of this location. Non-null.