Interface RunConfig

All Known Implementing Classes:
BeanRunConfig, ModelRunConfig
public interface RunConfig
Context provider for maven executors and checkers. Never to be implemented by client code.

  • Method Details

    • getExecutionDirectory

      File getExecutionDirectory()
      directory where the maven build execution happens.
      Returns:

    • setExecutionDirectory

      void setExecutionDirectory(File directory)

    • getPreExecution

      RunConfig getPreExecution()

    • setPreExecution

      void setPreExecution(RunConfig config)

    • getReactorStyle

      RunConfig.ReactorStyle getReactorStyle()

    • getProject

      org.netbeans.api.project.Project getProject()
      project that is being used for execution, can be null.
      Returns:

    • getMavenProject

      org.apache.maven.project.MavenProject getMavenProject()
      the maven project instance loaded with the context of execution, with execution's profiles enabled and execution properties injected. Can differd from the MavenProject returned from within the Project instance. All Maven model checks shall be done against this instance.
      Returns:

    • getGoals

      List<String> getGoals()
      goals to be executed.
      Returns:
      a list of goals to run

    • getExecutionName

      String getExecutionName()

    • getTaskDisplayName

      String getTaskDisplayName()

    • getActionName

      String getActionName()

    • getOptions

      @NonNull Map<? extends String, ? extends String> getOptions()
      Options/switches passed to maven.
      Returns:
      a read-only copy of the current maven options
      Since:
      2.167

    • setOption

      void setOption(@NonNull String key, @NullAllowed String value)
      Sets option that will be passed to maven.
      Parameters:
      key - a key that represents option/switch name
      value - a value of the option/switch
      Since:
      2.167

    • addOptions

      void addOptions(@NonNull Map<String,String> options)
      Adds options/switches that will be passed to maven.
      Parameters:
      options - options/switches that will be added
      Since:
      2.167

    • getProperties

      @NonNull Map<? extends String, ? extends String> getProperties()
      Properties to be used in execution.
      Returns:
      a read-only copy of the current properties (possibly inherited from the parent)

    • setProperty

      void setProperty(@NonNull String key, @NullAllowed String value)

    • addProperties

      void addProperties(@NonNull Map<String,String> properties)

    • setInternalProperty

      void setInternalProperty(@NonNull String key, @NullAllowed Object value)

    • getInternalProperties

      @NonNull Map<? extends String, ? extends Object> getInternalProperties()

    • isShowDebug

      boolean isShowDebug()

    • isShowError

      boolean isShowError()

    • isOffline

      Boolean isOffline()

    • setOffline

      void setOffline(Boolean bool)

    • isRecursive

      boolean isRecursive()

    • isUpdateSnapshots

      boolean isUpdateSnapshots()

    • getActivatedProfiles

      List<String> getActivatedProfiles()

    • setActivatedProfiles

      void setActivatedProfiles(List<String> profiles)

    • isInteractive

      boolean isInteractive()

    • getSelectedFileObject

      org.openide.filesystems.FileObject getSelectedFileObject()

    • getActionContext

      default org.openide.util.Lookup getActionContext()
      Provides access to possible additional parameters from the action invoker. Must not return null, use Lookup.EMPTY for empty instance.
      Returns:
      action context Lookup
      Since:
      2.144