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.io.File;
22  import java.util.List;
23  import java.util.Map;
24  
25  /**
26   * Describes the environmental context used to determine the activation status of profiles.
27   *
28   * @author Benjamin Bentmann
29   */
30  public interface ProfileActivationContext {
31      /**
32       * Key of the property containing the project's packaging.
33       * Available in {@link #getUserProperties()}.
34       * @since 4.0
35       */
36      String PROPERTY_NAME_PACKAGING = "packaging";
37  
38      /**
39       * Gets the identifiers of those profiles that should be activated by explicit demand.
40       *
41       * @return The identifiers of those profiles to activate, never {@code null}.
42       */
43      List<String> getActiveProfileIds();
44  
45      /**
46       * Gets the identifiers of those profiles that should be deactivated by explicit demand.
47       *
48       * @return The identifiers of those profiles to deactivate, never {@code null}.
49       */
50      List<String> getInactiveProfileIds();
51  
52      /**
53       * Gets the system properties to use for interpolation and profile activation. The system properties are collected
54       * from the runtime environment like {@link System#getProperties()} and environment variables.
55       *
56       * @return The execution properties, never {@code null}.
57       */
58      Map<String, String> getSystemProperties();
59  
60      /**
61       * Gets the user properties to use for interpolation and profile activation. The user properties have been
62       * configured directly by the user on his discretion, e.g. via the {@code -Dkey=value} parameter on the command
63       * line.
64       *
65       * @return The user properties, never {@code null}.
66       */
67      Map<String, String> getUserProperties();
68  
69      /**
70       * Gets the base directory of the current project (if any).
71       *
72       * @return The base directory of the current project or {@code null} if none.
73       */
74      File getProjectDirectory();
75  
76      /**
77       * Gets current calculated project properties
78       *
79       * @return The project properties, never {@code null}.
80       */
81      Map<String, String> getProjectProperties();
82  }