Package org.apache.maven.project.overlay

Class BuildOverlay

  • All Implemented Interfaces:
    java.io.Serializable
    public class BuildOverlay
extends Build
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      BuildOverlay​(Build build)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addExtension​(Extension extension)
      Method addExtension.
      void addFilter​(java.lang.String string)
      Method addFilter.
      void addPlugin​(Plugin plugin)
      Method addPlugin.
      void addResource​(Resource resource)
      Method addResource.
      void addTestResource​(Resource resource)
      Method addTestResource.
      boolean equals​(java.lang.Object obj)  
      void flushPluginMap()
      Reset the pluginsMap field to null
      java.lang.String getDefaultGoal()
      Get the default goal (or phase in Maven 2) to execute when none is specified for the project.
      java.lang.String getDirectory()
      Get the directory where all files generated by the build are placed.
      java.util.List getExtensions()
      Method getExtensions.
      java.util.List getFilters()
      Method getFilters.
      java.lang.String getFinalName()
      Get the filename (excluding the extension, and with no path information) that the produced artifact will be called.
      java.lang.String getOutputDirectory()
      Get the directory where compiled application classes are placed.
      PluginManagement getPluginManagement()
      Get default plugin information to be made available for reference by projects derived from this one.
      java.util.List getPlugins()
      Method getPlugins.
      java.util.Map getPluginsAsMap()  
      java.util.List getResources()
      Method getResources.
      java.lang.String getScriptSourceDirectory()
      Get this element specifies a directory containing the script sources of the project.
      java.lang.String getSourceDirectory()
      Get this element specifies a directory containing the source of the project.
      java.lang.String getTestOutputDirectory()
      Get the directory where compiled test classes are placed.
      java.util.List getTestResources()
      Method getTestResources.
      java.lang.String getTestSourceDirectory()
      Get this element specifies a directory containing the unit test source of the project.
      int hashCode()  
      void removeExtension​(Extension extension)
      Method removeExtension.
      void removeFilter​(java.lang.String string)
      Method removeFilter.
      void removePlugin​(Plugin plugin)
      Method removePlugin.
      void removeResource​(Resource resource)
      Method removeResource.
      void removeTestResource​(Resource resource)
      Method removeTestResource.
      void setDefaultGoal​(java.lang.String defaultGoal)
      Set the default goal (or phase in Maven 2) to execute when none is specified for the project.
      void setDirectory​(java.lang.String directory)
      Set the directory where all files generated by the build are placed.
      void setExtensions​(java.util.List extensions)
      Set a set of build extensions to use from this project.
      void setFilters​(java.util.List filters)
      Set the list of filter properties files that are used when filtering is enabled.
      void setFinalName​(java.lang.String finalName)
      Set the filename (excluding the extension, and with no path information) that the produced artifact will be called.
      void setOutputDirectory​(java.lang.String outputDirectory)
      Set the directory where compiled application classes are placed.
      void setPluginManagement​(PluginManagement pluginManagement)
      Set default plugin information to be made available for reference by projects derived from this one.
      void setPlugins​(java.util.List plugins)
      Set the list of plugins to use.
      void setResources​(java.util.List resources)
      Set this element describes all of the classpath resources such as properties files associated with a project.
      void setScriptSourceDirectory​(java.lang.String scriptSourceDirectory)
      Set this element specifies a directory containing the script sources of the project.
      void setSourceDirectory​(java.lang.String sourceDirectory)
      Set this element specifies a directory containing the source of the project.
      void setTestOutputDirectory​(java.lang.String testOutputDirectory)
      Set the directory where compiled test classes are placed.
      void setTestResources​(java.util.List testResources)
      Set this element describes all of the classpath resources such as properties files associated with a project's unit tests.
      void setTestSourceDirectory​(java.lang.String testSourceDirectory)
      Set this element specifies a directory containing the unit test source of the project.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Field Detail

      • build

        private final Build build

      • resources

        private java.util.List resources

      • testResources

        private java.util.List testResources

    • Constructor Detail

      • BuildOverlay

        public BuildOverlay​(Build build)

    • Method Detail

      • addExtension

        public void addExtension​(Extension extension)
        Description copied from class: Build
        Method addExtension.
        Overrides:
        addExtension in class Build

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • getDefaultGoal

        public java.lang.String getDefaultGoal()
        Description copied from class: BuildBase
        Get the default goal (or phase in Maven 2) to execute when none is specified for the project.
        Overrides:
        getDefaultGoal in class BuildBase
        Returns:
        String

      • getDirectory

        public java.lang.String getDirectory()
        Description copied from class: BuildBase
        Get the directory where all files generated by the build are placed.
        Overrides:
        getDirectory in class BuildBase
        Returns:
        String

      • getExtensions

        public java.util.List getExtensions()
        Description copied from class: Build
        Method getExtensions.
        Overrides:
        getExtensions in class Build
        Returns:
        List

      • getFinalName

        public java.lang.String getFinalName()
        Description copied from class: BuildBase
        Get the filename (excluding the extension, and with no path information) that the produced artifact will be called. The default value is ${artifactId}-${version}.
        Overrides:
        getFinalName in class BuildBase
        Returns:
        String

      • getOutputDirectory

        public java.lang.String getOutputDirectory()
        Description copied from class: Build
        Get the directory where compiled application classes are placed.
        Overrides:
        getOutputDirectory in class Build
        Returns:
        String

      • getPluginManagement

        public PluginManagement getPluginManagement()
        Description copied from class: PluginConfiguration
        Get default plugin information to be made available for reference by projects derived from this one. This plugin configuration will not be resolved or bound to the lifecycle unless referenced. Any local configuration for a given plugin will override the plugin's entire definition here.
        Overrides:
        getPluginManagement in class PluginConfiguration
        Returns:
        PluginManagement

      • getResources

        public java.util.List getResources()
        Description copied from class: BuildBase
        Method getResources.
        Overrides:
        getResources in class BuildBase
        Returns:
        List

      • getScriptSourceDirectory

        public java.lang.String getScriptSourceDirectory()
        Description copied from class: Build
        Get this element specifies a directory containing the script sources of the project. This directory is meant to be different from the sourceDirectory, in that its contents will be copied to the output directory in most cases (since scripts are interpreted rather than compiled).
        Overrides:
        getScriptSourceDirectory in class Build
        Returns:
        String

      • getSourceDirectory

        public java.lang.String getSourceDirectory()
        Description copied from class: Build
        Get this element specifies a directory containing the source of the project. The generated build system will compile the source in this directory when the project is built. The path given is relative to the project descriptor.
        Overrides:
        getSourceDirectory in class Build
        Returns:
        String

      • getTestOutputDirectory

        public java.lang.String getTestOutputDirectory()
        Description copied from class: Build
        Get the directory where compiled test classes are placed.
        Overrides:
        getTestOutputDirectory in class Build
        Returns:
        String

      • getTestResources

        public java.util.List getTestResources()
        Description copied from class: BuildBase
        Method getTestResources.
        Overrides:
        getTestResources in class BuildBase
        Returns:
        List

      • getTestSourceDirectory

        public java.lang.String getTestSourceDirectory()
        Description copied from class: Build
        Get this element specifies a directory containing the unit test source of the project. The generated build system will compile these directories when the project is being tested. The path given is relative to the project descriptor.
        Overrides:
        getTestSourceDirectory in class Build
        Returns:
        String

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • removeExtension

        public void removeExtension​(Extension extension)
        Description copied from class: Build
        Method removeExtension.
        Overrides:
        removeExtension in class Build

      • setDefaultGoal

        public void setDefaultGoal​(java.lang.String defaultGoal)
        Description copied from class: BuildBase
        Set the default goal (or phase in Maven 2) to execute when none is specified for the project.
        Overrides:
        setDefaultGoal in class BuildBase

      • setDirectory

        public void setDirectory​(java.lang.String directory)
        Description copied from class: BuildBase
        Set the directory where all files generated by the build are placed.
        Overrides:
        setDirectory in class BuildBase

      • setExtensions

        public void setExtensions​(java.util.List extensions)
        Description copied from class: Build
        Set a set of build extensions to use from this project.
        Overrides:
        setExtensions in class Build

      • setFinalName

        public void setFinalName​(java.lang.String finalName)
        Description copied from class: BuildBase
        Set the filename (excluding the extension, and with no path information) that the produced artifact will be called. The default value is ${artifactId}-${version}.
        Overrides:
        setFinalName in class BuildBase

      • setOutputDirectory

        public void setOutputDirectory​(java.lang.String outputDirectory)
        Description copied from class: Build
        Set the directory where compiled application classes are placed.
        Overrides:
        setOutputDirectory in class Build

      • setPluginManagement

        public void setPluginManagement​(PluginManagement pluginManagement)
        Description copied from class: PluginConfiguration
        Set default plugin information to be made available for reference by projects derived from this one. This plugin configuration will not be resolved or bound to the lifecycle unless referenced. Any local configuration for a given plugin will override the plugin's entire definition here.
        Overrides:
        setPluginManagement in class PluginConfiguration

      • setResources

        public void setResources​(java.util.List resources)
        Description copied from class: BuildBase
        Set 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.
        Overrides:
        setResources in class BuildBase

      • setScriptSourceDirectory

        public void setScriptSourceDirectory​(java.lang.String scriptSourceDirectory)
        Description copied from class: Build
        Set this element specifies a directory containing the script sources of the project. This directory is meant to be different from the sourceDirectory, in that its contents will be copied to the output directory in most cases (since scripts are interpreted rather than compiled).
        Overrides:
        setScriptSourceDirectory in class Build

      • setSourceDirectory

        public void setSourceDirectory​(java.lang.String sourceDirectory)
        Description copied from class: Build
        Set this element specifies a directory containing the source of the project. The generated build system will compile the source in this directory when the project is built. The path given is relative to the project descriptor.
        Overrides:
        setSourceDirectory in class Build

      • setTestOutputDirectory

        public void setTestOutputDirectory​(java.lang.String testOutputDirectory)
        Description copied from class: Build
        Set the directory where compiled test classes are placed.
        Overrides:
        setTestOutputDirectory in class Build

      • setTestResources

        public void setTestResources​(java.util.List testResources)
        Description copied from class: BuildBase
        Set this element describes all of the classpath resources such as properties files associated with a project's unit tests.
        Overrides:
        setTestResources in class BuildBase

      • setTestSourceDirectory

        public void setTestSourceDirectory​(java.lang.String testSourceDirectory)
        Description copied from class: Build
        Set this element specifies a directory containing the unit test source of the project. The generated build system will compile these directories when the project is being tested. The path given is relative to the project descriptor.
        Overrides:
        setTestSourceDirectory in class Build

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • addFilter

        public void addFilter​(java.lang.String string)
        Description copied from class: BuildBase
        Method addFilter.
        Overrides:
        addFilter in class BuildBase

      • getFilters

        public java.util.List getFilters()
        Description copied from class: BuildBase
        Method getFilters.
        Overrides:
        getFilters in class BuildBase
        Returns:
        List

      • removeFilter

        public void removeFilter​(java.lang.String string)
        Description copied from class: BuildBase
        Method removeFilter.
        Overrides:
        removeFilter in class BuildBase

      • setFilters

        public void setFilters​(java.util.List filters)
        Description copied from class: BuildBase
        Set the list of filter properties files that are used when filtering is enabled.
        Overrides:
        setFilters in class BuildBase