001package org.apache.maven.model.profile;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import java.util.Collection;
023import java.util.List;
024
025import org.apache.maven.model.Profile;
026import org.apache.maven.model.building.ModelProblemCollector;
027
028/**
029 * Calculates the active profiles among a given collection of profiles.
030 * 
031 * @author Benjamin Bentmann
032 */
033public interface ProfileSelector
034{
035
036    /**
037     * Determines the profiles which are active in the specified activation context. Active profiles will eventually be
038     * injected into the model.
039     * 
040     * @param profiles The profiles whose activation status should be determined, must not be {@code null}.
041     * @param context The environmental context used to determine the activation status of a profile, must not be
042     *            {@code null}.
043     * @param problems The container used to collect problems that were encountered, must not be {@code null}.
044     * @return The profiles that have been activated, never {@code null}.
045     */
046    List<Profile> getActiveProfiles( Collection<Profile> profiles, ProfileActivationContext context,
047                                     ModelProblemCollector problems );
048
049}