com.mulesoft.tools.migration.step.category

Interface MigrationReport<T>

Type Parameters:

T -

public interface MigrationReport<T>

An interface to feed the migration report.

Since:

1.0.0

Author:

Mulesoft Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MigrationReport.Level Represents the severity of a report entry.

Method Summary

Modifier and Type	Method and Description
void	addProcessedElements(int processedElements) Adds the passed value to the counter of processed elements.
List<T>	getReportEntries() Returns the report entries.
void	initialize(ProjectType projectType, String projectName) Sets some basic metadata about the project to be populated into the report.
void	report(MigrationReport.Level level, org.jdom2.Element element, org.jdom2.Element elementToComment, String message, String... documentationLinks) Deprecated. Use #report(String, Element, Element) instead.
void	report(String entryKey, org.jdom2.Element element, org.jdom2.Element elementToComment, String... messageParams) Adds the report entry to the target report, and as a comment on the element being processed.

Method Detail

initialize

void initialize(ProjectType projectType,
                String projectName)

Sets some basic metadata about the project to be populated into the report.

Parameters:

projectType -

projectName -

report

void report(String entryKey,
            org.jdom2.Element element,
            org.jdom2.Element elementToComment,
            String... messageParams)

Adds the report entry to the target report, and as a comment on the element being processed.

Parameters:

entryKey - the key of the report entry to generate, as defined in a report.yaml file.

element - the XML element that generated this report entry.

elementToComment - the XML element inside of which the report entry will be.

messageParams - the strings to use to replace value placeholders in report entry message.

report

@Deprecated
void report(MigrationReport.Level level,
                        org.jdom2.Element element,
                        org.jdom2.Element elementToComment,
                        String message,
                        String... documentationLinks)

Deprecated. Use #report(String, Element, Element) instead.

Adds the report entry to the target report, and as a comment on the element being processed.

Parameters:

level -

element - the XML element that generated this report entry.

elementToComment - the XML element inside of which the report entry will be.

message -

documentationLinks - the links to the Mule documentation that contain the explanation of any changes needed in the migrated app.

addProcessedElements

void addProcessedElements(int processedElements)

Adds the passed value to the counter of processed elements.

This value is later used as the denominator to calculate the migration ratio.

Parameters:

processedElements -

getReportEntries

List<T> getReportEntries()

Returns the report entries.