Package de.carne.gradle.plugin.java.ext

Class GenerateI18N

  • public class GenerateI18N
extends java.lang.Object
    Configuration object for GenerateI18NTask.

    build.gradle: 

     javatools {
  generateI18N {
   ...
  }
 }

    • Constructor Summary

      Constructors 
      Constructor Description
      GenerateI18N​(org.gradle.api.Project project)
      Constructs a new GenerateI18N instance.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.gradle.api.file.ConfigurableFileTree getBundles()
      Gets the resource bundles to process.
      java.lang.String getEncoding()
      Gets the encoding to use during generation.
      java.io.File getGenDir()
      Gets the target folder for the generated I18N helper classes.
      java.lang.String getKeyFilter()
      Gets the pattern string identifying the resource bundle keys to be processed during generation.
      java.lang.String getLineSeparator()
      Gets the line separator to use during generation.
      boolean isEnabled()
      Checks whether the generation of I18N helper classes is enabled.
      void setBundles​(org.gradle.api.file.ConfigurableFileTree bundles)
      Sets the resource bundles to process.
      void setEnabled​(boolean enabled)
      Enables/disables the generation of I18N helper classes.
      void setEncoding​(java.lang.String encoding)
      Sets the encoding to use during generation.
      void setGenDir​(java.io.File genDir)
      Sets the target folder for the generated I18N helper classes.
      void setKeyFilter​(java.lang.String keyFilter)
      Sets the pattern string identifying the resource bundle keys to be processed during generation.
      void setLineSeparator​(java.lang.String lineSeparator)
      Sets the line separator to use during generation.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • GenerateI18N

        public GenerateI18N​(org.gradle.api.Project project)
        Constructs a new GenerateI18N instance.
        Parameters:
        project - the owning Project.

    • Method Detail

      • isEnabled

        public boolean isEnabled()
        Checks whether the generation of I18N helper classes is enabled.

        build.gradle: 

         generateI18N {
  enabled = true|false // default: false
 }
        Returns:
        true if the generation of I18N helper classes is enabled.

      • setEnabled

        public void setEnabled​(boolean enabled)
        Enables/disables the generation of I18N helper classes.

        build.gradle: 

         generateI18N {
  enabled = true|false // default: false
 }
        Parameters:
        enabled - whether to enable or disable the generation of I18N helper classes.

      • getKeyFilter

        public java.lang.String getKeyFilter()
        Gets the pattern string identifying the resource bundle keys to be processed during generation.

        build.gradle: 

         generateI18N {
  keyFilter = "..." // default: "^I18N_.*"
 }
        Returns:
        the pattern string identifying the resource bundle keys to be processed during generation.

      • setKeyFilter

        public void setKeyFilter​(java.lang.String keyFilter)
        Sets the pattern string identifying the resource bundle keys to be processed during generation.

        build.gradle: 

         generateI18N {
  keyFilter = "..." // default: "^I18N_.*"
 }
        Parameters:
        keyFilter - the pattern string identifying the resource bundle keys to be processed during generation.

      • getGenDir

        public java.io.File getGenDir()
        Gets the target folder for the generated I18N helper classes.

        build.gradle: 

         generateI18N {
  genDir = file(...) // default: file("${buildDir}/generated-src/i18n/main/java")
 }
        Returns:
        the target folder for the generated I18N helper classes.

      • setGenDir

        public void setGenDir​(java.io.File genDir)
        Sets the target folder for the generated I18N helper classes.

        build.gradle: 

         generateI18N {
  genDir = file(...) // default: file("${buildDir}/generated-src/i18n/main/java")
 }
        Parameters:
        genDir - the target folder for the generated I18N helper classes.

      • getBundles

        public org.gradle.api.file.ConfigurableFileTree getBundles()
        Gets the resource bundles to process.

        build.gradle: 

         generateI18N {
  bundles = fileTree(...) // default: fileTree("src/main/resources").include("**/*I18N.properties")
 }
        Returns:
        the resource bundles to process.

      • setBundles

        public void setBundles​(org.gradle.api.file.ConfigurableFileTree bundles)
        Sets the resource bundles to process.

        build.gradle: 

         generateI18N {
  bundles = fileTree(...) // default: fileTree("src/main/resources").include("**/*I18N.properties")
 }
        Parameters:
        bundles - the resource bundles to process.

      • getLineSeparator

        public java.lang.String getLineSeparator()
        Gets the line separator to use during generation.

        build.gradle: 

         generateI18N {
  lineSeparator = "\n" // default: System.getProperty("line.separator")
 }
        Returns:
        the line separator to use during generation.

      • setLineSeparator

        public void setLineSeparator​(java.lang.String lineSeparator)
        Sets the line separator to use during generation.

        build.gradle: 

         generateI18N {
  lineSeparator = "\n" // default: System.getProperty("line.separator")
 }
        Parameters:
        lineSeparator - the line separator to use during generation.

      • getEncoding

        public java.lang.String getEncoding()
        Gets the encoding to use during generation.

        build.gradle: 

         generateI18N {
  encoding = "ISO-8859-1" // default: System.getProperty("file.encoding","UTF-8")
 }
        Returns:
        the encoding to use during generation.

      • setEncoding

        public void setEncoding​(java.lang.String encoding)
        Sets the encoding to use during generation.

        build.gradle: 

         generateI18N {
  encoding = "ISO-8859-1" // default: System.getProperty("file.encoding","UTF-8")
 }
        Parameters:
        encoding - the encoding to use during generation.