BranchMojo

java.lang.Object
- org.apache.maven.plugin.AbstractMojo
- - org.apache.maven.scm.plugin.AbstractScmMojo
  - - org.apache.maven.scm.plugin.BranchMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
```
@Mojo(name="branch",
      aggregator=true)
public class BranchMojo
extends AbstractScmMojo
```
Branch the project.

Field Summary

Fields
Modifier and Type	Field	Description
`private java.lang.String`	`branch`	The branch name.
`private java.lang.String`	`message`	The message applied to the tag creation.
`private boolean`	`pinExternals`	Currently only implemented with Subversion.
`private boolean`	`remoteBranching`	Currently only implemented with svn scm.

Fields inherited from class org.apache.maven.scm.plugin.AbstractScmMojo
VALID_VERSION_TYPES, VERSION_TYPE_BRANCH, VERSION_TYPE_REVISION, VERSION_TYPE_TAG

Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE

Constructor Summary

Constructors
Constructor Description

BranchMojo(ScmManager manager, org.apache.maven.settings.crypto.SettingsDecrypter settingsDecrypter)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

void execute()
- Methods inherited from class org.apache.maven.scm.plugin.AbstractScmMojo
  checkResult, getBasedir, getConnectionUrl, getExcludes, getFileSet, getIncludes, getScmManager, getScmRepository, getScmVersion, getWorkingDirectory, handleExcludesIncludesAfterCheckoutAndExport, setConnectionType, setConnectionUrl, setExcludes, setIncludes, setWorkingDirectory
- Methods inherited from class org.apache.maven.plugin.AbstractMojo
  getLog, getPluginContext, setLog, setPluginContext
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - branch
```
@Parameter(property="branch",
           required=true)
private java.lang.String branch
```
    The branch name.
  - message
```
@Parameter(property="message")
private java.lang.String message
```
    The message applied to the tag creation.
  - remoteBranching
```
@Parameter(property="remoteBranching",
           defaultValue="true")
private boolean remoteBranching
```
    Currently only implemented with svn scm. Enable a workaround to prevent issue due to svn client > 1.5.0 (https://issues.apache.org/jira/browse/SCM-406)
    
    Since:
    
    1.3
  - pinExternals
```
@Parameter(property="pinExternals",
           defaultValue="false")
private boolean pinExternals
```
    Currently only implemented with Subversion. Enable the "--pin-externals" option in svn copy commands which is new in Subversion 1.9.
    
    Since:
    
    1.11.0
- Constructor Detail
  - BranchMojo
```
@Inject
public BranchMojo(ScmManager manager,
                  org.apache.maven.settings.crypto.SettingsDecrypter settingsDecrypter)
```
- Method Detail
  - execute
```
public void execute()
             throws org.apache.maven.plugin.MojoExecutionException
```
    Specified by:
    
    execute in interface org.apache.maven.plugin.Mojo
    
    Overrides:
    
    execute in class AbstractScmMojo
    
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException