Fork me on GitHub

directory-content:copyFile

Full name:

biz.gabrys.maven.plugins:directory-content-maven-plugin:2.0.1:copyFile

Description:

Copies file from source to output directory (allow to change name).

Attributes:

  • Requires a Maven project to be executed.
  • Since version: 1.1.0.
  • Binds by default to the lifecycle phase: process-sources.

Required Parameters

Name Type Since Description
<sourceFilePath> String 1.1.0 The source file path which will be copied (examples: filename.ext, directory/filename.ext).
User property is: directory.content.sourceFilePath.

Optional Parameters

Name Type Since Description
<force> boolean 1.1.0 Forces to always copy file. By default file is only copied when modified or the destination file does not exist.
Default value is: false.
User property is: directory.content.force.
<outputDirectory> File 1.1.0 The destination directory for copied file.
Default value is: ${project.build.directory}.
User property is: directory.content.outputDirectory.
<outputFilePath> String 1.1.0 The destination file path (examples: filename.ext, directory/filename.ext).
Default value is: the same as source file path.
User property is: directory.content.outputFilePath.
<skip> boolean 1.1.0 Defines whether to skip the plugin execution.
Default value is: false.
User property is: directory.content.skip.
<skipIfSourceFileDoesNotExist> boolean 1.2.0 Defines whether to skip the plugin execution if source file does not exist.
Default value is: false.
User property is: directory.content.skipIfSourceFileDoesNotExist.
<sourceDirectory> File 1.1.0 The directory with source file.
Default value is: ${basedir}.
User property is: directory.content.sourceDirectory.

Parameter Details

<force>

Forces to always copy file. By default file is only copied when modified or the destination file does not exist.
  • Type: boolean
  • Since: 1.1.0
  • Required: No
  • User Property: directory.content.force
  • Default: false

<outputDirectory>

The destination directory for copied file.
  • Type: java.io.File
  • Since: 1.1.0
  • Required: No
  • User Property: directory.content.outputDirectory
  • Default: ${project.build.directory}

<outputFilePath>

The destination file path (examples: filename.ext, directory/filename.ext).
Default value is: the same as source file path.
  • Type: java.lang.String
  • Since: 1.1.0
  • Required: No
  • User Property: directory.content.outputFilePath

<skip>

Defines whether to skip the plugin execution.
  • Type: boolean
  • Since: 1.1.0
  • Required: No
  • User Property: directory.content.skip
  • Default: false

<skipIfSourceFileDoesNotExist>

Defines whether to skip the plugin execution if source file does not exist.
  • Type: boolean
  • Since: 1.2.0
  • Required: No
  • User Property: directory.content.skipIfSourceFileDoesNotExist
  • Default: false

<sourceDirectory>

The directory with source file.
  • Type: java.io.File
  • Since: 1.1.0
  • Required: No
  • User Property: directory.content.sourceDirectory
  • Default: ${basedir}

<sourceFilePath>

The source file path which will be copied (examples: filename.ext, directory/filename.ext).
  • Type: java.lang.String
  • Since: 1.1.0
  • Required: Yes
  • User Property: directory.content.sourceFilePath