org.mule.runtime.ast.api

Interface ComponentMetadataAst

All Known Implementing Classes:

DefaultComponentMetadataAst

@NoImplement
public interface ComponentMetadataAst

Field Summary

Fields

Modifier and Type	Field and Description
static ComponentMetadataAst	EMPTY_METADATA

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getDocAttributes()
OptionalInt	getEndColumn()
OptionalInt	getEndLine()
Optional<String>	getFileName()
Optional<URI>	getFileUri()
List<ImportedResource>	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.
Map<String,Object>	getParserAttributes()
Optional<String>	getSourceCode()
OptionalInt	getStartColumn()
OptionalInt	getStartLine()

Field Detail

EMPTY_METADATA

static final ComponentMetadataAst EMPTY_METADATA

Method Detail

getFileName

Optional<String> getFileName()

Returns:

the config file name in which the owner component was defined. It may be empty if the component was created programmatically.

getFileUri

Optional<URI> getFileUri()

Returns:

the config file URI in which the owner component was defined. It may be empty if the component was created programmatically.

getImportChain

List<ImportedResource> 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 first import will be the first element of the returned list. Any other nested imports will be the subsequent elements of the returned list.

Returns:

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

Since:

1.5

getStartLine

OptionalInt getStartLine()

Returns:

the first line number in which the component was defined in the configuration file. It may be empty if the component was created programmatically. See also getParserAttributes() and AstParserAttribute for more precise DSL-specific location information.

getStartColumn

OptionalInt getStartColumn()

Returns:

the start column in which the component was defined in the configuration file. It may be empty if the component was created programmatically. See also getParserAttributes() and AstParserAttribute for more precise DSL-specific location information.

getEndLine

OptionalInt getEndLine()

Returns:

the last line number in which the component was defined in the configuration file. It may be empty if the component was created programmatically. See also getParserAttributes() and AstParserAttribute for more precise DSL-specific location information.

getEndColumn

OptionalInt getEndColumn()

Returns:

the end column in which the component was defined in the configuration file. It may be empty if the component was created programmatically. See also getParserAttributes() and AstParserAttribute for more precise DSL-specific location information.

getSourceCode

Optional<String> getSourceCode()

Returns:

the source code associated with the owner component. It may be empty if the component was created programmatically.

getDocAttributes

Map<String,String> getDocAttributes()

Returns:

a java.util.Map with the doc metadata from the source config.

getParserAttributes

Map<String,Object> getParserAttributes()

Returns:

a java.util.Map with metadata from the parser.