1 package org.apache.maven.model.profile.activation;
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 org.apache.maven.model.Profile;
23 import org.apache.maven.model.building.ModelProblemCollector;
24 import org.apache.maven.model.profile.ProfileActivationContext;
25
26 /**
27 * Determines whether a profile should be activated.
28 *
29 * @author Benjamin Bentmann
30 */
31 public interface ProfileActivator
32 {
33
34 /**
35 * Determines whether the specified profile is active in the given activator context.
36 *
37 * @param profile The profile whose activation status should be determined, must not be {@code null}.
38 * @param context The environmental context used to determine the activation status of the profile, must not be
39 * {@code null}.
40 * @param problems The container used to collect problems (e.g. bad syntax) that were encountered, must not be
41 * {@code null}.
42 * @return {@code true} if the profile is active, {@code false} otherwise.
43 */
44 boolean isActive( Profile profile, ProfileActivationContext context, ModelProblemCollector problems );
45
46 /**
47 * Determines whether specified activation method is present in configuration or not. It should help to have AND
48 * between activation conditions
49 * Need for solving http://jira.codehaus.org/browse/MNG-4565
50 * @param profile The profile whose activation status should be determined, must not be {@code null}.
51 * @param context The environmental context used to determine the activation status of the profile, must not be
52 * {@code null}.
53 * @param problems The container used to collect problems (e.g. bad syntax) that were encountered, must not be
54 * {@code null}.
55 * @return {@code true} if the profile is active, {@code false} otherwise.
56 */
57 boolean presentInConfig( Profile profile, ProfileActivationContext context, ModelProblemCollector problems );
58
59 }