Class DefaultProfileActivationContext

java.lang.Object
org.apache.maven.impl.model.DefaultProfileActivationContext
All Implemented Interfaces:
ProfileActivationContext
public class DefaultProfileActivationContext extends Object implements ProfileActivationContext
Describes the environmental context used to determine the activation status of profiles.

  • Constructor Details

    • DefaultProfileActivationContext

      public DefaultProfileActivationContext(PathTranslator pathTranslator, RootLocator rootLocator, org.apache.maven.api.services.Interpolator interpolator)

    • DefaultProfileActivationContext

      public DefaultProfileActivationContext(PathTranslator pathTranslator, RootLocator rootLocator, org.apache.maven.api.services.Interpolator interpolator, List<String> activeProfileIds, List<String> inactiveProfileIds, Map<String,String> systemProperties, Map<String,String> userProperties, org.apache.maven.api.model.Model model)

  • Method Details

    • isProfileActive

      public boolean isProfileActive(String profileId)
      Description copied from interface: ProfileActivationContext
      Checks if the specified profile has been explicitly activated.
      Specified by:
      isProfileActive in interface ProfileActivationContext
      Parameters:
      profileId - the profile id
      Returns:
      whether the profile has been activated

    • isProfileInactive

      public boolean isProfileInactive(String profileId)
      Description copied from interface: ProfileActivationContext
      Checks if the specified profile has been explicitly deactivated.
      Specified by:
      isProfileInactive in interface ProfileActivationContext
      Parameters:
      profileId - the profile id
      Returns:
      whether the profile has been deactivated

    • getSystemProperty

      public String getSystemProperty(String key)
      Description copied from interface: ProfileActivationContext
      Gets the system property to use for interpolation and profile activation. The system properties are collected from the runtime environment like System.getProperties() and environment variables.
      Specified by:
      getSystemProperty in interface ProfileActivationContext
      Parameters:
      key - the name of the system property
      Returns:
      the system property for the specified key, or null

    • setSystemProperties

      public DefaultProfileActivationContext setSystemProperties(Map<String,String> systemProperties)
      Sets the system properties to use for interpolation and profile activation. The system properties are collected from the runtime environment like System.getProperties() and environment variables.
      Parameters:
      systemProperties - The system properties, may be null.
      Returns:
      This context, never null.

    • getUserProperty

      public String getUserProperty(String key)
      Description copied from interface: ProfileActivationContext
      Gets the user property to use for interpolation and profile activation. The user properties have been configured directly by the user on his discretion, e.g. via the -Dkey=value parameter on the command line.
      Specified by:
      getUserProperty in interface ProfileActivationContext
      Parameters:
      key - the name of the user property
      Returns:
      The user property for the specified key, or null.

    • setUserProperties

      public DefaultProfileActivationContext setUserProperties(Map<String,String> userProperties)
      Sets the user properties to use for interpolation and profile activation. The user properties have been configured directly by the user on his discretion, e.g. via the -Dkey=value parameter on the command line.
      Parameters:
      userProperties - The user properties, may be null.
      Returns:
      This context, never null.

    • getModelArtifactId

      public String getModelArtifactId()
      Description copied from interface: ProfileActivationContext
      Gets the artifactId from the current model.
      Specified by:
      getModelArtifactId in interface ProfileActivationContext
      Returns:
      The artifactId of the current model, or null if not set.

    • getModelPackaging

      public String getModelPackaging()
      Description copied from interface: ProfileActivationContext
      Gets the packaging type from the current model.
      Specified by:
      getModelPackaging in interface ProfileActivationContext
      Returns:
      The packaging type of the current model, or null if not set.

    • getModelProperty

      public String getModelProperty(String key)
      Description copied from interface: ProfileActivationContext
      Gets the model property to use for interpolation and profile activation.
      Specified by:
      getModelProperty in interface ProfileActivationContext
      Parameters:
      key - the name of the model property
      Returns:
      The model property for the specified key, or null;

    • getModelBaseDirectory

      public String getModelBaseDirectory()
      Description copied from interface: ProfileActivationContext
      Gets the base directory of the current model.
      Specified by:
      getModelBaseDirectory in interface ProfileActivationContext
      Returns:
      The base directory path of the current model, or null if not set.

    • doGetModelBaseDirectory

      public String doGetModelBaseDirectory()

    • getModelRootDirectory

      public String getModelRootDirectory()
      Description copied from interface: ProfileActivationContext
      Gets the root directory of the current model.
      Specified by:
      getModelRootDirectory in interface ProfileActivationContext
      Returns:
      The root directory path of the current model, or null if not set.

    • setModel

      public DefaultProfileActivationContext setModel(org.apache.maven.api.model.Model model)

    • interpolatePath

      public String interpolatePath(String path) throws org.apache.maven.api.services.InterpolatorException
      Description copied from interface: ProfileActivationContext
      Interpolates the given path string using the current context's properties.
      Specified by:
      interpolatePath in interface ProfileActivationContext
      Parameters:
      path - The path string to interpolate
      Returns:
      The interpolated path string
      Throws:
      org.apache.maven.api.services.InterpolatorException - if an error occurs during interpolation

    • exists

      public boolean exists(String path, boolean enableGlob) throws org.apache.maven.api.services.ModelBuilderException
      Description copied from interface: ProfileActivationContext
      Checks if a file or directory matching the given glob pattern exists at the specified path.
      Specified by:
      exists in interface ProfileActivationContext
      Parameters:
      path - the base path to check
      enableGlob - whether the path can be a glob expression
      Returns:
      true if a matching file exists, false otherwise
      Throws:
      org.apache.maven.api.services.ModelBuilderException - if an error occurs while checking the path