Specifies whether to add target as a source folder to this project. As this is the behaviour that most projects will want, the default is true.

The pattern used for identifying adder methods via reflection when analyzing classes. This needs to be a valid regular expression with the first group being the name of the property. The default value is:

add(.+)

If this is set to true, the generated builders will use adder methods. Adder methods will take precedence over setters if both are available.

The package in which to place the generated builders.

Relative paths can be specified with the help of <PACKAGE_NAME>. As <PACKAGE_NAME> is also the default value, builders will be placed within the same package as the classes built by them if nothing else is specified.

The suffix to append to builder classes. The default value is Builder, meaning a builder for a class named Person would be named PersonBuilder.

Specifies whether to delete orphaned builders from the directory.

A builder is considered orphaned if it would no longer be generated during a clean build, be it due to a class having been deleted or renamed or due to the configuration having been changed.

As this is the behaviour that most projects will want, the default is true.

If this is set to true, the generated builders will use direct field access if possible and if no setter is available.

Specifies classes to be excluded when generating builders.

A single <exclude>..</exclude> can be specified in the following ways:

• <exclude>
      <className>fully.qualified.ClassName</className>
  </exclude>

• <exclude>
      <classRegex>regex.for.Class[A-Z]+</className>
  </exclude>

• <exclude>
      <packageName>fully.qualified.package.name</packageName>
  </exclude>

• <exclude>
      <packageRegex>regex.for.packages.[a-z]+</packageRegex>
  </exclude>

If not specified, the default value is set to exclude classes ending with Builder or BuilderImpl.

If this is set to true, it is assumed that getters of collections without a corresponding setter will lazily initialize the underlying collection. The generated builders will use a get-and-add paradigm where necessary to construct a collection.

The prefix used for identifying getter methods via reflection when analyzing classes. The default value is get.

Properties relating to hierarchy collection of classes.

• hierarchyCollection.excludes

  Specifies classes to be excluded from the hierarchy collection. They will not be added to the result. Furthermore, if a class from excludes is encountered during ancestor traversal of the starting class it is immediately stopped.

  A single <exclude>..</exclude> can be specified in the following ways:

  • <exclude>
        <className>fully.qualified.ClassName</className>
    </exclude>

  • <exclude>
        <classRegex>regex.for.Class[A-Z]+</className>
    </exclude>

  • <exclude>
        <packageName>fully.qualified.package.name</packageName>
    </exclude>

  • <exclude>
        <packageRegex>regex.for.packages.[a-z]+</packageRegex>
    </exclude>

Specifies the classes for which to generate builders.

A single <include>..</include> can be specified in the following ways:

• <include>
      <className>fully.qualified.ClassName</className>
  </include>

• <include>
      <packageName>fully.qualified.package.name</packageName>
  </include>

The prefix used for identifying setter methods via reflection when analyzing classes. The default value is set.

The target directory in which to place the generated builders.

If not specified, the default value is dependent on the org.apache.maven.plugins.annotations.LifecyclePhase.

For any test-related phase, the default target directory will be the following:
${project.build.directory}/generated-test-sources/builders
For any other phase, the default target directory will be:
${project.build.directory}/generated-sources/builders