View Javadoc
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.model.profile;
20  
21  import java.util.Collection;
22  import java.util.List;
23  
24  import org.apache.maven.model.Profile;
25  import org.apache.maven.model.building.ModelProblemCollector;
26  
27  /**
28   * Calculates the active profiles among a given collection of profiles.
29   *
30   */
31  public interface ProfileSelector {
32  
33      /**
34       * Determines the profiles which are active in the specified activation context. Active profiles will eventually be
35       * injected into the model.
36       *
37       * @param profiles The profiles whose activation status should be determined, must not be {@code null}.
38       * @param context The environmental context used to determine the activation status of a profile, must not be
39       *            {@code null}.
40       * @param problems The container used to collect problems that were encountered, must not be {@code null}.
41       * @return The profiles that have been activated, never {@code null}.
42       */
43      List<Profile> getActiveProfiles(
44              Collection<Profile> profiles, ProfileActivationContext context, ModelProblemCollector problems);
45  }