Lifecycle API

Author: gnodet

api/maven-api-core/src/main/java/org/apache/maven/api/Lifecycle.java

@@ -0,0 +1,157 @@
+/*
+ * 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;
+
+import java.util.*;
+import java.util.stream.Stream;
+
+import org.apache.maven.api.annotations.Experimental;
+import org.apache.maven.api.annotations.Immutable;
+import org.apache.maven.api.model.Plugin;
+
+/**
+ * Lifecycle definition
+ *
+ * @since 4.0.0
+ */
+@Experimental
+@Immutable
+public interface Lifecycle extends ExtensibleEnum {
+
+    String CLEAN = "clean";
+
+    String DEFAULT = "default";
+
+    String SITE = "site";
+
+    String WRAPPER = "wrapper";
+
+    String PRE = "pre:";
+    String POST = "post:";
+    String RUN = "run:";
+
+    String READY = "ready";
+    String PACKAGE = "package";
+
+    /**
+     * Name or identifier of this lifecycle.
+     *
+     * @return the unique identifier for this lifecycle
+     */
+    @Override
+    String id();
+
+    /**
+     * Collection of phases for this lifecycle
+     */
+    Collection<Phase> phases();
+
+    /**
+     * Stream of phases containing all child phases recursively.
+     */
+    default Stream<Phase> allPhases() {
+        return phases().stream().flatMap(Phase::allPhases);
+    }
+
+    /**
+     * Collection of aliases.
+     */
+    Collection<Alias> aliases();
+
+    /**
+     * Pre-ordered list of phases.
+     * If not provided, a default order will be computed.
+     */
+    default Optional<List<String>> orderedPhases() {
+        return Optional.empty();
+    }
+
+    /**
+     * A phase in the lifecycle.
+     */
+    interface Phase {
+        String name();
+
+        List<Plugin> plugins();
+
+        Collection<Link> links();
+
+        List<Phase> phases();
+
+        Stream<Phase> allPhases();
+    }
+
+    /**
+     * A phase alias, mostly used to support the Maven 3 phases which are mapped
+     * to dynamic phases in Maven 4.
+     */
+    interface Alias {
+        String v3Phase();
+
+        String v4Phase();
+    }
+
+    /**
+     * A link from a phase to another phase, consisting of a type which can be
+     * {@link Kind#Before} or {@link Kind#After}, and a {@link Pointer} to
+     * another phase.
+     */
+    interface Link {
+        enum Kind {
+            Before,
+            After
+        }
+
+        Kind kind();
+
+        Pointer pointer();
+    }
+
+    interface Pointer {
+        enum Type {
+            Project,
+            Dependencies,
+            Children
+        }
+
+        String phase();
+
+        Type type();
+    }
+
+    interface PhasePointer extends Pointer {
+        default Type type() {
+            return Type.Project;
+        }
+    }
+
+    interface DependenciesPointer extends Pointer {
+        String scope(); // default: all
+
+        default Type type() {
+            return Type.Dependencies;
+        }
+    }
+
+    interface ChildrenPointer extends Pointer {
+        default Type type() {
+            return Type.Children;
+        }
+    }
+}

api/maven-api-core/src/main/java/org/apache/maven/api/Packaging.java

@@ -18,9 +18,12 @@
  */
 package org.apache.maven.api;
 
+import java.util.Optional;
+
 import org.apache.maven.api.annotations.Experimental;
 import org.apache.maven.api.annotations.Immutable;
 import org.apache.maven.api.annotations.Nonnull;
+import org.apache.maven.api.model.PluginContainer;
 
 /**
  * Interface representing a Maven project packaging.
@@ -52,4 +55,11 @@ default Language language() {
      */
     @Nonnull
     Type getType();
+
+    /**
+     * Returns the binding to use specifically for this packaging.
+     * This will be merged to the default packaging definition.
+     */
+    @Nonnull
+    Optional<PluginContainer> getPlugins();
 }

api/maven-api-core/src/main/java/org/apache/maven/api/PathScope.java

@@ -46,6 +46,7 @@
 @Immutable
 public interface PathScope extends ExtensibleEnum {
 
+    // TODO: what if I simply want all dependencies ?
     @Nonnull
     ProjectScope projectScope();
 

api/maven-api-core/src/main/java/org/apache/maven/api/plugin/annotations/After.java

@@ -0,0 +1,66 @@
+/*
+ * 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.plugin.annotations;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Inherited;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import org.apache.maven.api.annotations.Experimental;
+
+/**
+ * Specifies that the mojo should be run after the specific phase.
+ *
+ * @since 4.0.0
+ */
+@Experimental
+@Documented
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.TYPE)
+@Inherited
+public @interface After {
+
+    /**
+     * Type of pointer.
+     * @see org.apache.maven.api.Lifecycle.Pointer.Type
+     */
+    enum Type {
+        Project,
+        Dependencies,
+        Children
+    }
+
+    /**
+     * The phase name.
+     */
+    String phase();
+
+    /**
+     * The type of this pointer.
+     */
+    Type type();
+
+    /**
+     * The scope for dependencies, only if {@code type() == Type.Dependencies}.
+     */
+    String scope() default "";
+}

api/maven-api-core/src/main/java/org/apache/maven/api/plugin/annotations/Execute.java

@@ -41,21 +41,10 @@
 public @interface Execute {
     /**
      * Lifecycle phase to fork. Note that specifying a phase overrides specifying a goal.
-     * For custom lifecycle phase ids use {@link #customPhase()} instead.
-     * Only one of {@link #customPhase()} and {@link #phase()} must be set.
      * @return the phase
      */
     @Nonnull
-    LifecyclePhase phase() default LifecyclePhase.NONE;
-
-    /**
-     * Custom lifecycle phase to fork. Note that specifying a phase overrides specifying a goal.
-     * This element should only be used for non-standard phases. For standard phases rather use {@link #phase()}.
-     * Only one of {@link #customPhase()} and {@link #phase()} must be set.
-     * @return the custom phase id
-     */
-    @Nonnull
-    String customPhase() default "";
+    String phase() default "";
 
     /**
      * Goal to fork. Note that specifying a phase overrides specifying a goal. The specified <code>goal</code> must be

api/maven-api-core/src/main/java/org/apache/maven/api/plugin/annotations/LifecyclePhase.java

@@ -54,7 +54,7 @@
      * @return the default phase
      */
     @Nonnull
-    LifecyclePhase defaultPhase() default LifecyclePhase.NONE;
+    String defaultPhase() default "";
 
     /**
      * does your mojo requires a project to be executed?