1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.maven.api;
20
21 import java.util.*;
22
23 import org.apache.maven.api.annotations.Experimental;
24 import org.apache.maven.api.annotations.Immutable;
25 import org.apache.maven.api.model.Plugin;
26
27 /**
28 * Lifecycle definition
29 *
30 * @since 4.0.0
31 */
32 @Experimental
33 @Immutable
34 public interface Lifecycle extends ExtensibleEnum {
35
36 String CLEAN = "clean";
37
38 String DEFAULT = "default";
39
40 String SITE = "site";
41
42 String WRAPPER = "wrapper";
43
44 /**
45 * Name or identifier of this lifecycle.
46 *
47 * @return the unique identifier for this lifecycle
48 */
49 @Override
50 String id();
51
52 /**
53 * Collection of phases for this lifecycle
54 */
55 Collection<Phase> phases();
56
57 /**
58 * Pre-ordered list of phases.
59 * If not provided, a default order will be computed.
60 */
61 default Optional<List<String>> orderedPhases() {
62 return Optional.empty();
63 }
64
65 /**
66 * A phase in the lifecycle.
67 */
68 interface Phase {
69 String name();
70
71 List<Plugin> plugins();
72 }
73 }