View Javadoc

1   package org.apache.maven.model.profile;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import java.util.Collection;
23  import java.util.List;
24  
25  import org.apache.maven.model.Profile;
26  import org.apache.maven.model.building.ModelProblemCollector;
27  
28  /**
29   * Calculates the active profiles among a given collection of profiles.
30   * 
31   * @author Benjamin Bentmann
32   */
33  public interface ProfileSelector
34  {
35  
36      /**
37       * Determines the profiles which are active in the specified activation context. Active profiles will eventually be
38       * injected into the model.
39       * 
40       * @param profiles The profiles whose activation status should be determined, must not be {@code null}.
41       * @param context The environmental context used to determine the activation status of a profile, must not be
42       *            {@code null}.
43       * @param problems The container used to collect problems that were encountered, must not be {@code null}.
44       * @return The profiles that have been activated, never {@code null}.
45       */
46      List<Profile> getActiveProfiles( Collection<Profile> profiles, ProfileActivationContext context,
47                                       ModelProblemCollector problems );
48  
49  }