Fork me on GitHub

yml2props:convert

Full name:

io.github.cernier:yml2props-maven-plugin:1.0.0-SNAPSHOT:convert

Description:

Converts YAML resources files to Java's format .properties files.

Attributes:

  • Requires a Maven project to be executed.
  • Binds by default to the lifecycle phase: process-resources.

Required Parameters

Name Type Since Description
<deleteOriginalFileAfterSuccessfulConversion> boolean 1.0.0 Whether original file should be deleted after successful conversion.
Default value is: true.
User property is: deleteOriginalFileAfterSuccessfulConversion.
<includes> String 1.0.0 Comma-separated concatenation of list of patterns that follow the Scanner.setIncludes()'s "Maven standard", specifying the resources to convert.
Default value is: **/*.yml,**/*.yaml.
User property is: includes.
<inputCharset> String 1.0.0 Name of one of StandardCharsets to use for reading input files to convert.
Default value is: UTF-8.
User property is: inputCharset.
<inputDirectory> File 1.0.0 The root directory where to find resources to convert, according to includes parameter.
Default value is: ${project.build.outputDirectory}.
User property is: inputDirectory.
<outputCharset> String 1.0.0 Name of one of StandardCharsets to use for writing output files after conversion.
Default value is: UTF-8.
User property is: outputCharset.

Parameter Details

<deleteOriginalFileAfterSuccessfulConversion>

Whether original file should be deleted after successful conversion.
  • Type: boolean
  • Since: 1.0.0
  • Required: Yes
  • User Property: deleteOriginalFileAfterSuccessfulConversion
  • Default: true

<includes>

Comma-separated concatenation of list of patterns that follow the Scanner.setIncludes()'s "Maven standard", specifying the resources to convert.
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: Yes
  • User Property: includes
  • Default: **/*.yml,**/*.yaml

<inputCharset>

Name of one of StandardCharsets to use for reading input files to convert.
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: Yes
  • User Property: inputCharset
  • Default: UTF-8

<inputDirectory>

The root directory where to find resources to convert, according to includes parameter.
  • Type: java.io.File
  • Since: 1.0.0
  • Required: Yes
  • User Property: inputDirectory
  • Default: ${project.build.outputDirectory}

<outputCharset>

Name of one of StandardCharsets to use for writing output files after conversion.
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: Yes
  • User Property: outputCharset
  • Default: UTF-8