diff --git a/api/maven-api-spi/src/main/java/org/apache/maven/api/spi/ModelParser.java b/api/maven-api-spi/src/main/java/org/apache/maven/api/spi/ModelParser.java index b2d89e469979..39c810958ef8 100644 --- a/api/maven-api-spi/src/main/java/org/apache/maven/api/spi/ModelParser.java +++ b/api/maven-api-spi/src/main/java/org/apache/maven/api/spi/ModelParser.java @@ -34,11 +34,12 @@ * The {@code ModelParser} interface is used to locate and read {@link Model}s from the file system. * This allows plugging in additional syntaxes for the main model read by Maven when building a project. *
- * Note: if component names of {@link ModelParser} and {@link ModelWriter} are same, the pair is considered - * a "model dialect", as reading from- and writing to- this dialect becomes possible (symmetrical). Hence, - * "model translation" as read from one dialect and write out to another dialect becomes possible as well. + * Note: to provide Maven model "dialect", that can have models translated from-to, implement {@link ModelDialectProvider} + * that compose pairs of parser and writer (make dialect symmetrical). * * @since 4.0.0 + * @see ModelDialectProvider + * @see DialectProvider */ @Experimental @Consumer diff --git a/api/maven-api-spi/src/main/java/org/apache/maven/api/spi/ModelWriter.java b/api/maven-api-spi/src/main/java/org/apache/maven/api/spi/ModelWriter.java index 1cbb87f179d4..6eef1481c4e9 100644 --- a/api/maven-api-spi/src/main/java/org/apache/maven/api/spi/ModelWriter.java +++ b/api/maven-api-spi/src/main/java/org/apache/maven/api/spi/ModelWriter.java @@ -33,11 +33,12 @@ * The {@code ModelWriter} interface is used to write {@link Model}s to the file system. * This allows plugging in additional syntaxes for the main model write. *
- * Note: if component names of {@link ModelParser} and {@link ModelWriter} are same, the pair is considered - * a "model dialect", as reading from- and writing to- this dialect becomes possible (symmetrical). Hence, - * "model translation" as read from one dialect and write out to another dialect becomes possible as well. + * Note: to provide Maven model "dialect", that can have models translated from-to, implement {@link ModelDialectProvider} + * that compose pairs of parser and writer (make dialect symmetrical). * * @since 4.0.0 + * @see ModelDialectProvider + * @see DialectProvider */ @Experimental @Consumer