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