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