Package org.apache.maven.api.model

Class BuildBase

java.lang.Object
org.apache.maven.api.model.PluginContainer
org.apache.maven.api.model.PluginConfiguration
org.apache.maven.api.model.BuildBase
All Implemented Interfaces:
Serializable, InputLocationTracker
Direct Known Subclasses:
Build
@Experimental @Generated @ThreadSafe @Immutable public class BuildBase extends PluginConfiguration implements Serializable, InputLocationTracker
Build configuration in a profile.
See Also:

  • Method Details

    • getDefaultGoal

      public String getDefaultGoal()
      The default goal (or phase in Maven 2) to execute when none is specified for the project. Note that in case of a multi-module build, only the default goal of the top-level project is relevant, i.e. the default goals of child modules are ignored. Since Maven 3, multiple goals/phases can be separated by whitespace.
      Returns:
      a String

    • getResources

      @Nonnull public List<Resource> getResources()
      This element describes all of the classpath resources such as properties files associated with a project. These resources are often included in the final package. The default value is src/main/resources.
      Returns:
      a List<Resource>

    • getTestResources

      @Nonnull public List<Resource> getTestResources()
      This element describes all of the classpath resources such as properties files associated with a project's unit tests. The default value is src/test/resources.
      Returns:
      a List<Resource>

    • getDirectory

      public String getDirectory()
      The directory where all files generated by the build are placed. The default value is target.
      Returns:
      a String

    • getFinalName

      public String getFinalName()
      The filename (excluding the extension, and with no path information) that the produced artifact will be called. The default value is ${artifactId}-${version}.
      Returns:
      a String

    • getFilters

      @Nonnull public List<String> getFilters()
      The list of filter properties files that are used when filtering is enabled.
      Returns:
      a List<String>

    • getLocation

      public InputLocation getLocation(Object key)
      Gets the location of the specified field in the input source.
      Specified by:
      getLocation in interface InputLocationTracker
      Overrides:
      getLocation in class PluginConfiguration

    • with

      @Nonnull public BuildBase.Builder with()
      Creates a new builder with this object as the basis.
      Overrides:
      with in class PluginConfiguration
      Returns:
      a Builder

    • withPlugins

      @Nonnull public BuildBase withPlugins(Collection<Plugin> plugins)
      Creates a new BuildBase instance using the specified plugins.
      Overrides:
      withPlugins in class PluginConfiguration
      Parameters:
      plugins - the new Collection<Plugin> to use
      Returns:
      a BuildBase with the specified plugins

    • withPluginManagement

      @Nonnull public BuildBase withPluginManagement(PluginManagement pluginManagement)
      Creates a new BuildBase instance using the specified pluginManagement.
      Overrides:
      withPluginManagement in class PluginConfiguration
      Parameters:
      pluginManagement - the new PluginManagement to use
      Returns:
      a BuildBase with the specified pluginManagement

    • withDefaultGoal

      @Nonnull public BuildBase withDefaultGoal(String defaultGoal)
      Creates a new BuildBase instance using the specified defaultGoal.
      Parameters:
      defaultGoal - the new String to use
      Returns:
      a BuildBase with the specified defaultGoal

    • withResources

      @Nonnull public BuildBase withResources(Collection<Resource> resources)
      Creates a new BuildBase instance using the specified resources.
      Parameters:
      resources - the new Collection<Resource> to use
      Returns:
      a BuildBase with the specified resources

    • withTestResources

      @Nonnull public BuildBase withTestResources(Collection<Resource> testResources)
      Creates a new BuildBase instance using the specified testResources.
      Parameters:
      testResources - the new Collection<Resource> to use
      Returns:
      a BuildBase with the specified testResources

    • withDirectory

      @Nonnull public BuildBase withDirectory(String directory)
      Creates a new BuildBase instance using the specified directory.
      Parameters:
      directory - the new String to use
      Returns:
      a BuildBase with the specified directory

    • withFinalName

      @Nonnull public BuildBase withFinalName(String finalName)
      Creates a new BuildBase instance using the specified finalName.
      Parameters:
      finalName - the new String to use
      Returns:
      a BuildBase with the specified finalName

    • withFilters

      @Nonnull public BuildBase withFilters(Collection<String> filters)
      Creates a new BuildBase instance using the specified filters.
      Parameters:
      filters - the new Collection<String> to use
      Returns:
      a BuildBase with the specified filters

    • newInstance

      @Nonnull public static BuildBase newInstance()
      Creates a new BuildBase instance. Equivalent to newInstance( true ).
      Returns:
      a new BuildBase
      See Also:

    • newInstance

      @Nonnull public static BuildBase newInstance(boolean withDefaults)
      Creates a new BuildBase instance using default values or not. Equivalent to newBuilder( withDefaults ).build().
      Parameters:
      withDefaults - the boolean indicating whether default values should be used
      Returns:
      a new BuildBase

    • newBuilder

      @Nonnull public static BuildBase.Builder newBuilder()
      Creates a new BuildBase builder instance. Equivalent to newBuilder( true ).
      Returns:
      a new Builder
      See Also:

    • newBuilder

      @Nonnull public static BuildBase.Builder newBuilder(boolean withDefaults)
      Creates a new BuildBase builder instance using default values or not.
      Parameters:
      withDefaults - the boolean indicating whether default values should be used
      Returns:
      a new Builder

    • newBuilder

      @Nonnull public static BuildBase.Builder newBuilder(BuildBase from)
      Creates a new BuildBase builder instance using the specified object as a basis. Equivalent to newBuilder( from, false ).
      Parameters:
      from - the BuildBase instance to use as a basis
      Returns:
      a new Builder

    • newBuilder

      @Nonnull public static BuildBase.Builder newBuilder(BuildBase from, boolean forceCopy)
      Creates a new BuildBase builder instance using the specified object as a basis.
      Parameters:
      from - the BuildBase instance to use as a basis
      forceCopy - the boolean indicating if a copy should be forced
      Returns:
      a new Builder