LifecycleRegistry.java

/*
 * 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.services;

import java.util.List;
import java.util.stream.Stream;
import java.util.stream.StreamSupport;

import org.apache.maven.api.Lifecycle;

/**
 * Registry for {@link Lifecycle} extensible enum values.
 * <p>
 * In addition to the standard registry lookup operations, this interface provides
 * iteration over all registered lifecycles and computation of the ordered phase list
 * for a given lifecycle.
 *
 * @since 4.0.0
 */
public interface LifecycleRegistry extends ExtensibleEnumRegistry<Lifecycle>, Iterable<Lifecycle> {

    /**
     * Returns a sequential stream of all registered lifecycles.
     *
     * @return a stream of lifecycles
     */
    default Stream<Lifecycle> stream() {
        return StreamSupport.stream(spliterator(), false);
    }

    /**
     * Computes the ordered list of phase names for the given lifecycle.
     *
     * @param lifecycle the lifecycle whose phases should be computed
     * @return the ordered list of phase names
     */
    List<String> computePhases(Lifecycle lifecycle);
}