io.micronaut.starter.feature.DefaultFeature Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of micronaut-starter-core Show documentation

Generates Micronaut applications

There is a newer version: 4.7.0

Show newest version

/*
 * Copyright 2017-2022 original authors
 *
 * Licensed 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
 *
 * https://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 io.micronaut.starter.feature;

import io.micronaut.core.order.OrderUtil;
import io.micronaut.starter.application.ApplicationType;
import io.micronaut.starter.feature.build.BuildFeature;
import io.micronaut.starter.options.Options;

import java.util.Set;
import java.util.function.Consumer;
import java.util.stream.Stream;

/**
 * A default feature is one that should be applied to a
 * project conditionally without being explicitly selected.
 * If a feature must be chosen by the user in order to be applied,
 * then the feature is not a default feature.
 *
 * @author James Kleeh
 * @since 2.0.0
 */
public interface DefaultFeature extends Feature {

    /**
     * Determines if the feature should be applied to the project.
     *
     * Default features do not need to be concerned if the feature was already
     * selected and therefore is already in the list of selected features. The
     * addition to the set is based on the identity of the feature instance and
     * all features are singletons.
     *
     * @param applicationType  The application type
     * @param options          The options
     * @param selectedFeatures The features manually selected by the user
     * @return True if the feature should apply
     */
    boolean shouldApply(ApplicationType applicationType,
                        Options options,
                        Set selectedFeatures);

    default String getTargetFramework() {
        return Options.FRAMEWORK_MICRONAUT;
    }

    static void forEach(Stream featureStream, ApplicationType applicationType, Options options, Set features, Consumer featureConsumer) {
        featureStream
                    .filter(DefaultFeature.class::isInstance)
                    .sorted(OrderUtil.COMPARATOR.reversed())
                    .filter(f -> ((DefaultFeature) f).shouldApply(applicationType, options, features) && (
                            ((DefaultFeature) f).getTargetFramework().equals(options.getFramework()) || f instanceof BuildFeature
                    ))
                    .forEach(featureConsumer);
    }
}