This is an automated email from the ASF dual-hosted git repository. slachiewicz pushed a commit to branch maven-3.10.x in repository https://gitbox.apache.org/repos/asf/maven.git
commit 9a5cd4bd282a4e004c245233a5db72611fd8524e Author: Sylwester Lachiewicz <[email protected]> AuthorDate: Mon Nov 9 18:29:08 2026 +0100 Replace the 3.10 MessageBuilderFactory with the Maven 4 API org.apache.maven.message.MessageBuilderFactory was never visible to plugins: core exports org.apache.maven.* only for that exact package. Rather than export it, maven-core now carries Java 8 copies of org.apache.maven.api.services.MessageBuilder and MessageBuilderFactory from maven-api-core, with the annotations they use and Constants reduced to the style names, and Maven uses those itself. A plugin compiled against maven-api-core 4.x injects the same factory on 3.10 as on Maven 4. maven-jline now generates its Sisu index, so the JLine factory wins over the uncoloured default for every injection, Maven's own included. See #13917. --- .../main/java/org/apache/maven/api/Constants.java | 131 +++++++++++++++++++++ .../Service.java} | 46 +++----- .../annotations/Experimental.java} | 46 +++----- .../annotations/Nonnull.java} | 52 ++++---- .../annotations/ThreadSafe.java} | 49 +++----- .../{message => api/services}/MessageBuilder.java | 57 +++++---- .../services}/MessageBuilderFactory.java | 13 +- .../lifecycle/LifecycleExecutionException.java | 4 +- .../internal/DefaultMojoExecutionConfigurator.java | 4 +- .../internal/LifecycleDependencyResolver.java | 2 +- .../maven/lifecycle/internal/MojoExecutor.java | 2 +- .../message/internal/DefaultMessageBuilder.java | 2 +- .../internal/DefaultMessageBuilderFactory.java | 4 +- .../plugin/internal/DeprecatedPluginValidator.java | 2 +- .../main/resources/META-INF/maven/extension.xml | 4 + .../internal/DefaultMessageBuilderFactoryTest.java | 53 +++++++++ .../main/java/org/apache/maven/cli/MavenCli.java | 2 +- .../maven/cli/event/ExecutionEventLogger.java | 2 +- maven-jline/pom.xml | 9 ++ .../maven/jline/JLineMessageBuilderFactory.java | 4 +- .../java/org/apache/maven/jline/MessageUtils.java | 4 +- .../org/apache/maven/jline/MessageUtilsTest.java | 2 +- 22 files changed, 316 insertions(+), 178 deletions(-) diff --git a/maven-core/src/main/java/org/apache/maven/api/Constants.java b/maven-core/src/main/java/org/apache/maven/api/Constants.java new file mode 100644 index 0000000000..4591fb801f --- /dev/null +++ b/maven-core/src/main/java/org/apache/maven/api/Constants.java @@ -0,0 +1,131 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.maven.api; + +/** + * Configuration constants. + * <p> + * Maven 3 carries only the style names of the Maven 4 class, for {@link org.apache.maven.api.services.MessageBuilder}. + */ +public final class Constants { + + public static final String MAVEN_STYLE_PREFIX = "maven.style."; + + // Style Names + public static final String MAVEN_STYLE_TRANSFER_NAME = "transfer"; + public static final String MAVEN_STYLE_TRACE_NAME = "trace"; + public static final String MAVEN_STYLE_DEBUG_NAME = "debug"; + public static final String MAVEN_STYLE_INFO_NAME = "info"; + public static final String MAVEN_STYLE_WARNING_NAME = "warning"; + public static final String MAVEN_STYLE_ERROR_NAME = "error"; + public static final String MAVEN_STYLE_SUCCESS_NAME = "success"; + public static final String MAVEN_STYLE_FAILURE_NAME = "failure"; + public static final String MAVEN_STYLE_STRONG_NAME = "strong"; + public static final String MAVEN_STYLE_MOJO_NAME = "mojo"; + public static final String MAVEN_STYLE_PROJECT_NAME = "project"; + + // Default Values + public static final String MAVEN_STYLE_TRANSFER_DEFAULT = "f:bright-black"; + public static final String MAVEN_STYLE_TRACE_DEFAULT = "bold,f:magenta"; + public static final String MAVEN_STYLE_DEBUG_DEFAULT = "bold,f:cyan"; + public static final String MAVEN_STYLE_INFO_DEFAULT = "bold,f:blue"; + public static final String MAVEN_STYLE_WARNING_DEFAULT = "bold,f:yellow"; + public static final String MAVEN_STYLE_ERROR_DEFAULT = "bold,f:red"; + public static final String MAVEN_STYLE_SUCCESS_DEFAULT = "bold,f:green"; + public static final String MAVEN_STYLE_FAILURE_DEFAULT = "bold,f:red"; + public static final String MAVEN_STYLE_STRONG_DEFAULT = "bold"; + public static final String MAVEN_STYLE_MOJO_DEFAULT = "f:green"; + public static final String MAVEN_STYLE_PROJECT_DEFAULT = "f:cyan"; + + /** + * Maven output color mode. + * Allowed values are <code>auto</code>, <code>always</code>, <code>never</code>. + * + * @since 4.0.0 + */ + public static final String MAVEN_STYLE_COLOR_PROPERTY = MAVEN_STYLE_PREFIX + "color"; + + /** + * Color style for transfer messages. + * @since 4.0.0 + */ + public static final String MAVEN_STYLE_TRANSFER = MAVEN_STYLE_PREFIX + MAVEN_STYLE_TRANSFER_NAME; + + /** + * Color style for trace messages. + * @since 4.0.0 + */ + public static final String MAVEN_STYLE_TRACE = MAVEN_STYLE_PREFIX + MAVEN_STYLE_TRACE_NAME; + + /** + * Color style for debug messages. + * @since 4.0.0 + */ + public static final String MAVEN_STYLE_DEBUG = MAVEN_STYLE_PREFIX + MAVEN_STYLE_DEBUG_NAME; + + /** + * Color style for info messages. + * @since 4.0.0 + */ + public static final String MAVEN_STYLE_INFO = MAVEN_STYLE_PREFIX + MAVEN_STYLE_INFO_NAME; + + /** + * Color style for warning messages. + * @since 4.0.0 + */ + public static final String MAVEN_STYLE_WARNING = MAVEN_STYLE_PREFIX + MAVEN_STYLE_WARNING_NAME; + + /** + * Color style for error messages. + * @since 4.0.0 + */ + public static final String MAVEN_STYLE_ERROR = MAVEN_STYLE_PREFIX + MAVEN_STYLE_ERROR_NAME; + + /** + * Color style for success messages. + * @since 4.0.0 + */ + public static final String MAVEN_STYLE_SUCCESS = MAVEN_STYLE_PREFIX + MAVEN_STYLE_SUCCESS_NAME; + + /** + * Color style for failure messages. + * @since 4.0.0 + */ + public static final String MAVEN_STYLE_FAILURE = MAVEN_STYLE_PREFIX + MAVEN_STYLE_FAILURE_NAME; + + /** + * Color style for strong messages. + * @since 4.0.0 + */ + public static final String MAVEN_STYLE_STRONG = MAVEN_STYLE_PREFIX + MAVEN_STYLE_STRONG_NAME; + + /** + * Color style for mojo messages. + * @since 4.0.0 + */ + public static final String MAVEN_STYLE_MOJO = MAVEN_STYLE_PREFIX + MAVEN_STYLE_MOJO_NAME; + + /** + * Color style for project messages. + * @since 4.0.0 + */ + public static final String MAVEN_STYLE_PROJECT = MAVEN_STYLE_PREFIX + MAVEN_STYLE_PROJECT_NAME; + + private Constants() {} +} diff --git a/maven-core/src/main/java/org/apache/maven/message/internal/DefaultMessageBuilderFactory.java b/maven-core/src/main/java/org/apache/maven/api/Service.java similarity index 52% copy from maven-core/src/main/java/org/apache/maven/message/internal/DefaultMessageBuilderFactory.java copy to maven-core/src/main/java/org/apache/maven/api/Service.java index a3e1daf924..a15b46d6ea 100644 --- a/maven-core/src/main/java/org/apache/maven/message/internal/DefaultMessageBuilderFactory.java +++ b/maven-core/src/main/java/org/apache/maven/api/Service.java @@ -16,37 +16,19 @@ * specific language governing permissions and limitations * under the License. */ -package org.apache.maven.message.internal; +package org.apache.maven.api; -import javax.inject.Named; -import javax.inject.Singleton; +import org.apache.maven.api.annotations.Experimental; +import org.apache.maven.api.annotations.ThreadSafe; -import org.apache.maven.message.MessageBuilder; -import org.apache.maven.message.MessageBuilderFactory; -import org.eclipse.sisu.Priority; - -@Named -@Singleton -@Priority(-1) -public class DefaultMessageBuilderFactory implements MessageBuilderFactory { - - @Override - public boolean isColorEnabled() { - return false; - } - - @Override - public int getTerminalWidth() { - return -1; - } - - @Override - public MessageBuilder builder() { - return new DefaultMessageBuilder(); - } - - @Override - public MessageBuilder builder(int size) { - return new DefaultMessageBuilder(new StringBuilder(size)); - } -} +/** + * Marker interface for all services provided by the {@code Session}. + * <p> + * Services can be retrieved from the session using the + * {@code Session#getService(Class)} method. + * + * @since 4.0.0 + */ +@Experimental +@ThreadSafe +public interface Service {} diff --git a/maven-core/src/main/java/org/apache/maven/message/internal/DefaultMessageBuilderFactory.java b/maven-core/src/main/java/org/apache/maven/api/annotations/Experimental.java similarity index 52% copy from maven-core/src/main/java/org/apache/maven/message/internal/DefaultMessageBuilderFactory.java copy to maven-core/src/main/java/org/apache/maven/api/annotations/Experimental.java index a3e1daf924..6554cea294 100644 --- a/maven-core/src/main/java/org/apache/maven/message/internal/DefaultMessageBuilderFactory.java +++ b/maven-core/src/main/java/org/apache/maven/api/annotations/Experimental.java @@ -16,37 +16,19 @@ * specific language governing permissions and limitations * under the License. */ -package org.apache.maven.message.internal; +package org.apache.maven.api.annotations; -import javax.inject.Named; -import javax.inject.Singleton; +import java.lang.annotation.Documented; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; -import org.apache.maven.message.MessageBuilder; -import org.apache.maven.message.MessageBuilderFactory; -import org.eclipse.sisu.Priority; - -@Named -@Singleton -@Priority(-1) -public class DefaultMessageBuilderFactory implements MessageBuilderFactory { - - @Override - public boolean isColorEnabled() { - return false; - } - - @Override - public int getTerminalWidth() { - return -1; - } - - @Override - public MessageBuilder builder() { - return new DefaultMessageBuilder(); - } - - @Override - public MessageBuilder builder(int size) { - return new DefaultMessageBuilder(new StringBuilder(size)); - } -} +/** + * This annotation tags types that are part of an experimental API. + * Classes or methods annotated with this annotation may be changed / removed without notice. + * + * @since 4.0.0 + */ +@Experimental +@Documented +@Retention(RetentionPolicy.CLASS) +public @interface Experimental {} diff --git a/maven-core/src/main/java/org/apache/maven/message/internal/DefaultMessageBuilderFactory.java b/maven-core/src/main/java/org/apache/maven/api/annotations/Nonnull.java similarity index 52% copy from maven-core/src/main/java/org/apache/maven/message/internal/DefaultMessageBuilderFactory.java copy to maven-core/src/main/java/org/apache/maven/api/annotations/Nonnull.java index a3e1daf924..5a63fe61a1 100644 --- a/maven-core/src/main/java/org/apache/maven/message/internal/DefaultMessageBuilderFactory.java +++ b/maven-core/src/main/java/org/apache/maven/api/annotations/Nonnull.java @@ -16,37 +16,25 @@ * specific language governing permissions and limitations * under the License. */ -package org.apache.maven.message.internal; +package org.apache.maven.api.annotations; -import javax.inject.Named; -import javax.inject.Singleton; +import java.lang.annotation.Documented; +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; -import org.apache.maven.message.MessageBuilder; -import org.apache.maven.message.MessageBuilderFactory; -import org.eclipse.sisu.Priority; - -@Named -@Singleton -@Priority(-1) -public class DefaultMessageBuilderFactory implements MessageBuilderFactory { - - @Override - public boolean isColorEnabled() { - return false; - } - - @Override - public int getTerminalWidth() { - return -1; - } - - @Override - public MessageBuilder builder() { - return new DefaultMessageBuilder(); - } - - @Override - public MessageBuilder builder(int size) { - return new DefaultMessageBuilder(new StringBuilder(size)); - } -} +/** + * The annotated element must not be null. + * <p> + * Annotated fields must not be null after construction has completed. + * <p> + * When this annotation is applied to a method it applies to the method return value. + * + * @since 4.0.0 + */ +@Experimental +@Documented +@Retention(RetentionPolicy.CLASS) +@Target({ElementType.FIELD, ElementType.PARAMETER, ElementType.METHOD}) +public @interface Nonnull {} diff --git a/maven-core/src/main/java/org/apache/maven/message/internal/DefaultMessageBuilderFactory.java b/maven-core/src/main/java/org/apache/maven/api/annotations/ThreadSafe.java similarity index 52% copy from maven-core/src/main/java/org/apache/maven/message/internal/DefaultMessageBuilderFactory.java copy to maven-core/src/main/java/org/apache/maven/api/annotations/ThreadSafe.java index a3e1daf924..c3358680e7 100644 --- a/maven-core/src/main/java/org/apache/maven/message/internal/DefaultMessageBuilderFactory.java +++ b/maven-core/src/main/java/org/apache/maven/api/annotations/ThreadSafe.java @@ -16,37 +16,22 @@ * specific language governing permissions and limitations * under the License. */ -package org.apache.maven.message.internal; +package org.apache.maven.api.annotations; -import javax.inject.Named; -import javax.inject.Singleton; +import java.lang.annotation.Documented; +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; -import org.apache.maven.message.MessageBuilder; -import org.apache.maven.message.MessageBuilderFactory; -import org.eclipse.sisu.Priority; - -@Named -@Singleton -@Priority(-1) -public class DefaultMessageBuilderFactory implements MessageBuilderFactory { - - @Override - public boolean isColorEnabled() { - return false; - } - - @Override - public int getTerminalWidth() { - return -1; - } - - @Override - public MessageBuilder builder() { - return new DefaultMessageBuilder(); - } - - @Override - public MessageBuilder builder(int size) { - return new DefaultMessageBuilder(new StringBuilder(size)); - } -} +/** + * The {@code ThreadSafe} annotation can be used to indicate a given type + * is thread safe. {@code Immutable} objects are automatically thread safe. + * + * @since 4.0.0 + */ +@Experimental +@Documented +@Retention(RetentionPolicy.CLASS) +@Target(ElementType.TYPE) +public @interface ThreadSafe {} diff --git a/maven-core/src/main/java/org/apache/maven/message/MessageBuilder.java b/maven-core/src/main/java/org/apache/maven/api/services/MessageBuilder.java similarity index 80% rename from maven-core/src/main/java/org/apache/maven/message/MessageBuilder.java rename to maven-core/src/main/java/org/apache/maven/api/services/MessageBuilder.java index ee834aa374..ae0d249c33 100644 --- a/maven-core/src/main/java/org/apache/maven/message/MessageBuilder.java +++ b/maven-core/src/main/java/org/apache/maven/api/services/MessageBuilder.java @@ -16,12 +16,15 @@ * specific language governing permissions and limitations * under the License. */ -package org.apache.maven.message; +package org.apache.maven.api.services; + +import org.apache.maven.api.Constants; +import org.apache.maven.api.annotations.Nonnull; /** * Message builder that supports configurable styling. * - * @since 3.10.0 + * @since 4.0.0 * @see MessageBuilderFactory */ public interface MessageBuilder extends Appendable { @@ -33,6 +36,7 @@ public interface MessageBuilder extends Appendable { * @param message the message to append * @return the current builder */ + @Nonnull default MessageBuilder trace(Object message) { return style("." + Constants.MAVEN_STYLE_TRACE_NAME + ":-" + Constants.MAVEN_STYLE_TRACE_DEFAULT, message); } @@ -44,6 +48,7 @@ default MessageBuilder trace(Object message) { * @param message the message to append * @return the current builder */ + @Nonnull default MessageBuilder debug(Object message) { return style("." + Constants.MAVEN_STYLE_DEBUG_NAME + ":-" + Constants.MAVEN_STYLE_DEBUG_DEFAULT, message); } @@ -55,6 +60,7 @@ default MessageBuilder debug(Object message) { * @param message the message to append * @return the current builder */ + @Nonnull default MessageBuilder info(Object message) { return style("." + Constants.MAVEN_STYLE_INFO_NAME + ":-" + Constants.MAVEN_STYLE_INFO_DEFAULT, message); } @@ -66,6 +72,7 @@ default MessageBuilder info(Object message) { * @param message the message to append * @return the current builder */ + @Nonnull default MessageBuilder warning(Object message) { return style("." + Constants.MAVEN_STYLE_WARNING_NAME + ":-" + Constants.MAVEN_STYLE_WARNING_DEFAULT, message); } @@ -77,6 +84,7 @@ default MessageBuilder warning(Object message) { * @param message the message to append * @return the current builder */ + @Nonnull default MessageBuilder error(Object message) { return style("." + Constants.MAVEN_STYLE_ERROR_NAME + ":-" + Constants.MAVEN_STYLE_ERROR_DEFAULT, message); } @@ -88,6 +96,7 @@ default MessageBuilder error(Object message) { * @param message the message to append * @return the current builder */ + @Nonnull default MessageBuilder success(Object message) { return style("." + Constants.MAVEN_STYLE_SUCCESS_NAME + ":-" + Constants.MAVEN_STYLE_SUCCESS_DEFAULT, message); } @@ -99,6 +108,7 @@ default MessageBuilder success(Object message) { * @param message the message to append * @return the current builder */ + @Nonnull default MessageBuilder failure(Object message) { return style("." + Constants.MAVEN_STYLE_FAILURE_NAME + ":-" + Constants.MAVEN_STYLE_FAILURE_DEFAULT, message); } @@ -110,6 +120,7 @@ default MessageBuilder failure(Object message) { * @param message the message to append * @return the current builder */ + @Nonnull default MessageBuilder strong(Object message) { return style("." + Constants.MAVEN_STYLE_STRONG_NAME + ":-" + Constants.MAVEN_STYLE_STRONG_DEFAULT, message); } @@ -121,6 +132,7 @@ default MessageBuilder strong(Object message) { * @param message the message to append * @return the current builder */ + @Nonnull default MessageBuilder mojo(Object message) { return style("." + Constants.MAVEN_STYLE_MOJO_NAME + ":-" + Constants.MAVEN_STYLE_MOJO_DEFAULT, message); } @@ -132,10 +144,12 @@ default MessageBuilder mojo(Object message) { * @param message the message to append * @return the current builder */ + @Nonnull default MessageBuilder project(Object message) { return style("." + Constants.MAVEN_STYLE_PROJECT_NAME + ":-" + Constants.MAVEN_STYLE_PROJECT_DEFAULT, message); } + @Nonnull default MessageBuilder style(String style, Object message) { return style(style).a(message).resetStyle(); } @@ -148,12 +162,15 @@ default MessageBuilder style(String style, Object message) { // message building methods modelled after Ansi methods // + @Nonnull @Override MessageBuilder append(CharSequence cs); + @Nonnull @Override MessageBuilder append(CharSequence cs, int start, int end); + @Nonnull @Override MessageBuilder append(char c); @@ -165,6 +182,7 @@ default MessageBuilder style(String style, Object message) { * @param len the number of {@code char}s to append * @return the current builder */ + @Nonnull default MessageBuilder a(char[] value, int offset, int len) { return append(String.valueOf(value, offset, len)); } @@ -175,6 +193,7 @@ default MessageBuilder a(char[] value, int offset, int len) { * @param value the content to append * @return the current builder */ + @Nonnull default MessageBuilder a(char[] value) { return append(String.valueOf(value)); } @@ -187,6 +206,7 @@ default MessageBuilder a(char[] value) { * @param end the end index of the subsequence to be appended * @return the current builder */ + @Nonnull default MessageBuilder a(CharSequence value, int start, int end) { return append(value, start, end); } @@ -197,6 +217,7 @@ default MessageBuilder a(CharSequence value, int start, int end) { * @param value the content to append * @return the current builder */ + @Nonnull default MessageBuilder a(CharSequence value) { return append(value); } @@ -207,6 +228,7 @@ default MessageBuilder a(CharSequence value) { * @param value the content to append * @return the current builder */ + @Nonnull default MessageBuilder a(Object value) { return append(String.valueOf(value)); } @@ -216,6 +238,7 @@ default MessageBuilder a(Object value) { * * @return the current builder */ + @Nonnull default MessageBuilder newline() { return append(System.lineSeparator()); } @@ -228,6 +251,7 @@ default MessageBuilder newline() { * @param args arguments referenced by the format specifiers in the format string * @return the current builder */ + @Nonnull default MessageBuilder format(String pattern, Object... args) { return append(String.format(pattern, args)); } @@ -245,33 +269,6 @@ default MessageBuilder format(String pattern, Object... args) { * * @return the message */ + @Nonnull String build(); - - class Constants { - // Style Names - public static final String MAVEN_STYLE_TRANSFER_NAME = "transfer"; - public static final String MAVEN_STYLE_TRACE_NAME = "trace"; - public static final String MAVEN_STYLE_DEBUG_NAME = "debug"; - public static final String MAVEN_STYLE_INFO_NAME = "info"; - public static final String MAVEN_STYLE_WARNING_NAME = "warning"; - public static final String MAVEN_STYLE_ERROR_NAME = "error"; - public static final String MAVEN_STYLE_SUCCESS_NAME = "success"; - public static final String MAVEN_STYLE_FAILURE_NAME = "failure"; - public static final String MAVEN_STYLE_STRONG_NAME = "strong"; - public static final String MAVEN_STYLE_MOJO_NAME = "mojo"; - public static final String MAVEN_STYLE_PROJECT_NAME = "project"; - - // Default Values - public static final String MAVEN_STYLE_TRANSFER_DEFAULT = "f:bright-black"; - public static final String MAVEN_STYLE_TRACE_DEFAULT = "bold,f:magenta"; - public static final String MAVEN_STYLE_DEBUG_DEFAULT = "bold,f:cyan"; - public static final String MAVEN_STYLE_INFO_DEFAULT = "bold,f:blue"; - public static final String MAVEN_STYLE_WARNING_DEFAULT = "bold,f:yellow"; - public static final String MAVEN_STYLE_ERROR_DEFAULT = "bold,f:red"; - public static final String MAVEN_STYLE_SUCCESS_DEFAULT = "bold,f:green"; - public static final String MAVEN_STYLE_FAILURE_DEFAULT = "bold,f:red"; - public static final String MAVEN_STYLE_STRONG_DEFAULT = "bold"; - public static final String MAVEN_STYLE_MOJO_DEFAULT = "f:green"; - public static final String MAVEN_STYLE_PROJECT_DEFAULT = "f:cyan"; - } } diff --git a/maven-core/src/main/java/org/apache/maven/message/MessageBuilderFactory.java b/maven-core/src/main/java/org/apache/maven/api/services/MessageBuilderFactory.java similarity index 83% rename from maven-core/src/main/java/org/apache/maven/message/MessageBuilderFactory.java rename to maven-core/src/main/java/org/apache/maven/api/services/MessageBuilderFactory.java index 642ca7d773..9a595ae110 100644 --- a/maven-core/src/main/java/org/apache/maven/message/MessageBuilderFactory.java +++ b/maven-core/src/main/java/org/apache/maven/api/services/MessageBuilderFactory.java @@ -16,14 +16,19 @@ * specific language governing permissions and limitations * under the License. */ -package org.apache.maven.message; +package org.apache.maven.api.services; + +import org.apache.maven.api.Service; +import org.apache.maven.api.annotations.Experimental; +import org.apache.maven.api.annotations.Nonnull; /** * A factory for {@link MessageBuilder}. * - * @since 3.10.0 + * @since 4.0.0 */ -public interface MessageBuilderFactory { +@Experimental +public interface MessageBuilderFactory extends Service { /** * Checks if the underlying output does support styling or not. * @return whether color styling is supported or not @@ -40,6 +45,7 @@ public interface MessageBuilderFactory { * Creates a new message builder. * @return a new message builder */ + @Nonnull MessageBuilder builder(); /** @@ -47,5 +53,6 @@ public interface MessageBuilderFactory { * @param size the initial size of the message builder buffer * @return a new message builder */ + @Nonnull MessageBuilder builder(int size); } diff --git a/maven-core/src/main/java/org/apache/maven/lifecycle/LifecycleExecutionException.java b/maven-core/src/main/java/org/apache/maven/lifecycle/LifecycleExecutionException.java index 8636b78f03..ff67cf1bfa 100644 --- a/maven-core/src/main/java/org/apache/maven/lifecycle/LifecycleExecutionException.java +++ b/maven-core/src/main/java/org/apache/maven/lifecycle/LifecycleExecutionException.java @@ -18,8 +18,8 @@ */ package org.apache.maven.lifecycle; -import org.apache.maven.message.MessageBuilder; -import org.apache.maven.message.MessageBuilderFactory; +import org.apache.maven.api.services.MessageBuilder; +import org.apache.maven.api.services.MessageBuilderFactory; import org.apache.maven.message.internal.DefaultMessageBuilderFactory; import org.apache.maven.plugin.MojoExecution; import org.apache.maven.project.MavenProject; diff --git a/maven-core/src/main/java/org/apache/maven/lifecycle/internal/DefaultMojoExecutionConfigurator.java b/maven-core/src/main/java/org/apache/maven/lifecycle/internal/DefaultMojoExecutionConfigurator.java index 764a0c4123..172ecf7bbb 100644 --- a/maven-core/src/main/java/org/apache/maven/lifecycle/internal/DefaultMojoExecutionConfigurator.java +++ b/maven-core/src/main/java/org/apache/maven/lifecycle/internal/DefaultMojoExecutionConfigurator.java @@ -29,9 +29,9 @@ import java.util.stream.Collectors; import java.util.stream.Stream; +import org.apache.maven.api.services.MessageBuilder; +import org.apache.maven.api.services.MessageBuilderFactory; import org.apache.maven.lifecycle.MojoExecutionConfigurator; -import org.apache.maven.message.MessageBuilder; -import org.apache.maven.message.MessageBuilderFactory; import org.apache.maven.model.Plugin; import org.apache.maven.model.PluginExecution; import org.apache.maven.plugin.MojoExecution; diff --git a/maven-core/src/main/java/org/apache/maven/lifecycle/internal/LifecycleDependencyResolver.java b/maven-core/src/main/java/org/apache/maven/lifecycle/internal/LifecycleDependencyResolver.java index 466dd20329..740d8dbb63 100644 --- a/maven-core/src/main/java/org/apache/maven/lifecycle/internal/LifecycleDependencyResolver.java +++ b/maven-core/src/main/java/org/apache/maven/lifecycle/internal/LifecycleDependencyResolver.java @@ -33,12 +33,12 @@ import java.util.stream.Collectors; import org.apache.maven.RepositoryUtils; +import org.apache.maven.api.services.MessageBuilderFactory; import org.apache.maven.artifact.Artifact; import org.apache.maven.artifact.ArtifactUtils; import org.apache.maven.eventspy.internal.EventSpyDispatcher; import org.apache.maven.execution.MavenSession; import org.apache.maven.lifecycle.LifecycleExecutionException; -import org.apache.maven.message.MessageBuilderFactory; import org.apache.maven.project.DefaultDependencyResolutionRequest; import org.apache.maven.project.DependencyResolutionException; import org.apache.maven.project.DependencyResolutionResult; diff --git a/maven-core/src/main/java/org/apache/maven/lifecycle/internal/MojoExecutor.java b/maven-core/src/main/java/org/apache/maven/lifecycle/internal/MojoExecutor.java index 081eb6d3aa..e56b78f1a6 100644 --- a/maven-core/src/main/java/org/apache/maven/lifecycle/internal/MojoExecutor.java +++ b/maven-core/src/main/java/org/apache/maven/lifecycle/internal/MojoExecutor.java @@ -35,6 +35,7 @@ import java.util.concurrent.locks.ReentrantLock; import java.util.concurrent.locks.ReentrantReadWriteLock; +import org.apache.maven.api.services.MessageBuilderFactory; import org.apache.maven.artifact.Artifact; import org.apache.maven.artifact.resolver.filter.ArtifactFilter; import org.apache.maven.artifact.resolver.filter.CumulativeScopeArtifactFilter; @@ -43,7 +44,6 @@ import org.apache.maven.internal.MultilineMessageHelper; import org.apache.maven.lifecycle.LifecycleExecutionException; import org.apache.maven.lifecycle.MissingProjectException; -import org.apache.maven.message.MessageBuilderFactory; import org.apache.maven.plugin.BuildPluginManager; import org.apache.maven.plugin.MavenPluginManager; import org.apache.maven.plugin.MojoExecution; diff --git a/maven-core/src/main/java/org/apache/maven/message/internal/DefaultMessageBuilder.java b/maven-core/src/main/java/org/apache/maven/message/internal/DefaultMessageBuilder.java index 474244f738..318eb3d100 100644 --- a/maven-core/src/main/java/org/apache/maven/message/internal/DefaultMessageBuilder.java +++ b/maven-core/src/main/java/org/apache/maven/message/internal/DefaultMessageBuilder.java @@ -18,7 +18,7 @@ */ package org.apache.maven.message.internal; -import org.apache.maven.message.MessageBuilder; +import org.apache.maven.api.services.MessageBuilder; class DefaultMessageBuilder implements MessageBuilder { diff --git a/maven-core/src/main/java/org/apache/maven/message/internal/DefaultMessageBuilderFactory.java b/maven-core/src/main/java/org/apache/maven/message/internal/DefaultMessageBuilderFactory.java index a3e1daf924..95912d3c74 100644 --- a/maven-core/src/main/java/org/apache/maven/message/internal/DefaultMessageBuilderFactory.java +++ b/maven-core/src/main/java/org/apache/maven/message/internal/DefaultMessageBuilderFactory.java @@ -21,8 +21,8 @@ import javax.inject.Named; import javax.inject.Singleton; -import org.apache.maven.message.MessageBuilder; -import org.apache.maven.message.MessageBuilderFactory; +import org.apache.maven.api.services.MessageBuilder; +import org.apache.maven.api.services.MessageBuilderFactory; import org.eclipse.sisu.Priority; @Named diff --git a/maven-core/src/main/java/org/apache/maven/plugin/internal/DeprecatedPluginValidator.java b/maven-core/src/main/java/org/apache/maven/plugin/internal/DeprecatedPluginValidator.java index b876969d9a..198e50df0f 100644 --- a/maven-core/src/main/java/org/apache/maven/plugin/internal/DeprecatedPluginValidator.java +++ b/maven-core/src/main/java/org/apache/maven/plugin/internal/DeprecatedPluginValidator.java @@ -22,8 +22,8 @@ import javax.inject.Named; import javax.inject.Singleton; +import org.apache.maven.api.services.MessageBuilderFactory; import org.apache.maven.execution.MavenSession; -import org.apache.maven.message.MessageBuilderFactory; import org.apache.maven.plugin.PluginValidationManager; import org.apache.maven.plugin.descriptor.MojoDescriptor; import org.apache.maven.plugin.descriptor.Parameter; diff --git a/maven-core/src/main/resources/META-INF/maven/extension.xml b/maven-core/src/main/resources/META-INF/maven/extension.xml index c329b5e22a..39be3721a4 100644 --- a/maven-core/src/main/resources/META-INF/maven/extension.xml +++ b/maven-core/src/main/resources/META-INF/maven/extension.xml @@ -23,6 +23,10 @@ under the License. <exportedPackages> <!-- maven-* --> <exportedPackage>org.apache.maven.*</exportedPackage> + <!-- the Maven 4 API types Maven 3 provides, copied from maven-api-core --> + <exportedPackage>org.apache.maven.api.*</exportedPackage> + <exportedPackage>org.apache.maven.api.annotations.*</exportedPackage> + <exportedPackage>org.apache.maven.api.services.*</exportedPackage> <exportedPackage>org.apache.maven.artifact</exportedPackage> <exportedPackage>org.apache.maven.classrealm</exportedPackage> <exportedPackage>org.apache.maven.cli</exportedPackage> diff --git a/maven-core/src/test/java/org/apache/maven/message/internal/DefaultMessageBuilderFactoryTest.java b/maven-core/src/test/java/org/apache/maven/message/internal/DefaultMessageBuilderFactoryTest.java new file mode 100644 index 0000000000..f4e3bb6758 --- /dev/null +++ b/maven-core/src/test/java/org/apache/maven/message/internal/DefaultMessageBuilderFactoryTest.java @@ -0,0 +1,53 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.maven.message.internal; + +import javax.inject.Inject; + +import org.apache.maven.api.services.MessageBuilderFactory; +import org.codehaus.plexus.testing.PlexusTest; +import org.junit.jupiter.api.Test; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertInstanceOf; + +@PlexusTest +class DefaultMessageBuilderFactoryTest { + + @Inject + MessageBuilderFactory factory; + + @Test + void theApiFactoryIsBound() { + assertInstanceOf(DefaultMessageBuilderFactory.class, factory); + assertFalse(factory.isColorEnabled()); + assertEquals(-1, factory.getTerminalWidth()); + assertEquals( + "strong ok 42", + factory.builder() + .strong("strong") + .a(" ") + .success("ok") + .a(' ') + .a(42) + .build()); + assertEquals("", factory.builder(16).a("x").setLength(0).build()); + } +} diff --git a/maven-embedder/src/main/java/org/apache/maven/cli/MavenCli.java b/maven-embedder/src/main/java/org/apache/maven/cli/MavenCli.java index 2ec00edb7f..e4851b1499 100644 --- a/maven-embedder/src/main/java/org/apache/maven/cli/MavenCli.java +++ b/maven-embedder/src/main/java/org/apache/maven/cli/MavenCli.java @@ -56,6 +56,7 @@ import org.apache.maven.BuildAbort; import org.apache.maven.InternalErrorException; import org.apache.maven.Maven; +import org.apache.maven.api.services.MessageBuilder; import org.apache.maven.building.FileSource; import org.apache.maven.building.Problem; import org.apache.maven.building.Source; @@ -89,7 +90,6 @@ import org.apache.maven.extension.internal.CoreExtensionEntry; import org.apache.maven.jline.MessageUtils; import org.apache.maven.lifecycle.LifecycleExecutionException; -import org.apache.maven.message.MessageBuilder; import org.apache.maven.model.building.ModelProcessor; import org.apache.maven.model.interpolation.ModelInterpolator; import org.apache.maven.model.root.RootLocator; diff --git a/maven-embedder/src/main/java/org/apache/maven/cli/event/ExecutionEventLogger.java b/maven-embedder/src/main/java/org/apache/maven/cli/event/ExecutionEventLogger.java index 5a8a21a975..60b4e353b8 100644 --- a/maven-embedder/src/main/java/org/apache/maven/cli/event/ExecutionEventLogger.java +++ b/maven-embedder/src/main/java/org/apache/maven/cli/event/ExecutionEventLogger.java @@ -26,6 +26,7 @@ import java.util.Map; import java.util.Objects; +import org.apache.maven.api.services.MessageBuilder; import org.apache.maven.execution.AbstractExecutionListener; import org.apache.maven.execution.BuildFailure; import org.apache.maven.execution.BuildSuccess; @@ -34,7 +35,6 @@ import org.apache.maven.execution.MavenExecutionResult; import org.apache.maven.execution.MavenSession; import org.apache.maven.jline.MessageUtils; -import org.apache.maven.message.MessageBuilder; import org.apache.maven.plugin.MojoExecution; import org.apache.maven.plugin.descriptor.MojoDescriptor; import org.apache.maven.project.MavenProject; diff --git a/maven-jline/pom.xml b/maven-jline/pom.xml index d5381f7e3e..001f70b5ec 100644 --- a/maven-jline/pom.xml +++ b/maven-jline/pom.xml @@ -49,4 +49,13 @@ under the License. <scope>test</scope> </dependency> </dependencies> + + <build> + <plugins> + <plugin> + <groupId>org.eclipse.sisu</groupId> + <artifactId>sisu-maven-plugin</artifactId> + </plugin> + </plugins> + </build> </project> diff --git a/maven-jline/src/main/java/org/apache/maven/jline/JLineMessageBuilderFactory.java b/maven-jline/src/main/java/org/apache/maven/jline/JLineMessageBuilderFactory.java index 1f50840a37..936c9a6bff 100644 --- a/maven-jline/src/main/java/org/apache/maven/jline/JLineMessageBuilderFactory.java +++ b/maven-jline/src/main/java/org/apache/maven/jline/JLineMessageBuilderFactory.java @@ -28,8 +28,8 @@ import java.util.TreeSet; import java.util.concurrent.ConcurrentHashMap; -import org.apache.maven.message.MessageBuilder; -import org.apache.maven.message.MessageBuilderFactory; +import org.apache.maven.api.services.MessageBuilder; +import org.apache.maven.api.services.MessageBuilderFactory; import org.eclipse.sisu.Priority; /** diff --git a/maven-jline/src/main/java/org/apache/maven/jline/MessageUtils.java b/maven-jline/src/main/java/org/apache/maven/jline/MessageUtils.java index 249e189a9d..440a61f80c 100644 --- a/maven-jline/src/main/java/org/apache/maven/jline/MessageUtils.java +++ b/maven-jline/src/main/java/org/apache/maven/jline/MessageUtils.java @@ -25,8 +25,8 @@ import java.io.InputStreamReader; import java.lang.reflect.Method; -import org.apache.maven.message.MessageBuilder; -import org.apache.maven.message.MessageBuilderFactory; +import org.apache.maven.api.services.MessageBuilder; +import org.apache.maven.api.services.MessageBuilderFactory; /** * Colorized message support. Maven only needs ANSI colors in its log output, so there is no terminal library here: diff --git a/maven-jline/src/test/java/org/apache/maven/jline/MessageUtilsTest.java b/maven-jline/src/test/java/org/apache/maven/jline/MessageUtilsTest.java index 30b5ca9f36..dea4e4e14a 100644 --- a/maven-jline/src/test/java/org/apache/maven/jline/MessageUtilsTest.java +++ b/maven-jline/src/test/java/org/apache/maven/jline/MessageUtilsTest.java @@ -18,7 +18,7 @@ */ package org.apache.maven.jline; -import org.apache.maven.message.MessageBuilder; +import org.apache.maven.api.services.MessageBuilder; import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.Test;
