org.mule.tooling.client.api.component.location

Class ComponentLocation

java.lang.Object

org.mule.tooling.client.api.component.location.ComponentLocation

public class ComponentLocation
extends Object

Provides information about the location of a component within an application. 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/1 - the first 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 third on-error within the error handler of the first element of the flow with name FLOW_NAME

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
ComponentLocation(String location, TypedComponentIdentifier typedComponentIdentifier, List<LocationPart> locationParts, Optional<SourceCodeLocation> sourceCodeLocation)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
TypedComponentIdentifier	getComponentIdentifier()
Optional<String>	getFileName()
Optional<Integer>	getLineInFile()
String	getLocation()
List<LocationPart>	getParts()
Optional<SourceCodeLocation>	getSourceCodeLocation()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ComponentLocation

public ComponentLocation(String location,
                         TypedComponentIdentifier typedComponentIdentifier,
                         List<LocationPart> locationParts,
                         Optional<SourceCodeLocation> sourceCodeLocation)

Method Detail

getLocation

public String getLocation()

Returns:

the unique absolute path of the component in the application.

getFileName

public Optional<String> getFileName()

Returns:

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

getLineInFile

public Optional<Integer> getLineInFile()

Returns:

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

getSourceCodeLocation

public Optional<SourceCodeLocation> getSourceCodeLocation()

Returns:

the information of the location of the component in the configuration file. It may be empty if the components was added programmatically by the runtime.

getParts

public 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

public TypedComponentIdentifier getComponentIdentifier()

Returns:

the TypedComponentIdentifier of the component associated with this location

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object