Built by Maven

copy-rename:rename

Full name:

com.kohlschutter.mavenplugins:copy-rename-maven-plugin:2.0.0:rename

Description:

Rename files or directories during build.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Since version: 1.0.
  • Binds by default to the lifecycle phase: generate-sources.

Optional Parameters

Name Type Since Description
<destinationFile> File 1.0 The target file/directory name.
<fileSets> List<FileSet> 1.0 Collection of FileSets to work on (FileSet contains sourceFile and destinationFile). See Usage for details.
<ignoreExisting> boolean 2.0.0 Don't throw an error when overWrite is false and target file already exists.
Default value is: false.
User property is: copy.ignoreExisting.
<ignoreFileNotFoundOnIncremental> boolean 1.0 Ignore errors if the source file/directory was not found during incremental build.
Default value is: true.
User property is: copy.ignoreFileNotFoundOnIncremental.
<ignoreMissing> boolean 2.0.0 Ignore renaming this file if it does not exist.
Default value is: false.
User property is: copy.ignoreMissing.
<overWrite> boolean 1.0 Overwrite existing files.
Default value is: true.
User property is: copy.overWrite.
<skip> boolean 2.0.0 Skip execution.
Default value is: false.
User property is: copy.skip.
<sourceFile> File 1.0 The file/directory which has to be renamed.

Parameter Details

<destinationFile>

The target file/directory name.
  • Type: java.io.File
  • Since: 1.0
  • Required: No

<fileSets>

Collection of FileSets to work on (FileSet contains sourceFile and destinationFile). See Usage for details.
  • Type: java.util.List<com.kohlschutter.mavenplugins.copyrename.FileSet>
  • Since: 1.0
  • Required: No

<ignoreExisting>

Don't throw an error when overWrite is false and target file already exists.
  • Type: boolean
  • Since: 2.0.0
  • Required: No
  • User Property: copy.ignoreExisting
  • Default: false

<ignoreFileNotFoundOnIncremental>

Ignore errors if the source file/directory was not found during incremental build.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: copy.ignoreFileNotFoundOnIncremental
  • Default: true

<ignoreMissing>

Ignore renaming this file if it does not exist.
  • Type: boolean
  • Since: 2.0.0
  • Required: No
  • User Property: copy.ignoreMissing
  • Default: false

<overWrite>

Overwrite existing files.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: copy.overWrite
  • Default: true

<skip>

Skip execution.
  • Type: boolean
  • Since: 2.0.0
  • Required: No
  • User Property: copy.skip
  • Default: false

<sourceFile>

The file/directory which has to be renamed.
  • Type: java.io.File
  • Since: 1.0
  • Required: No