adding comment in properties files

Question

By using following block of code in build xml file   lt propertyfile file  default properties  comment  Default properties  gt      lt entry key  source dir  value  1    gt      lt entry key  dir publish  value  1    gt      lt entry key  dir publish html  value  1    gt   lt  propertyfile gt    I am able to generate default properties file with following file contents  source dir 1 dir publish 1 dir publish html 1   I want to know how can I add my comments in the generated file  E g  the generated properties should have the following content     Default Configuration source dir 1 dir publish 1   Source Configuration dir publish html 1   How can I do it dynamically using Ant s build xml

User · Answer

The property file task is for editing properties files  It contains all sorts of nice features that allow you to modify entries  For example    lt propertyfile file  build properties  gt       lt entry key  build number          type  int          operation             value  1   gt   lt  propertyfile gt    I ve incremented my build number by one  I have no idea what the value was  but it s now one greater than what it was before    Use the  lt echo gt  task to build a property file instead of  lt propertyfile gt   You can easily layout the content and then use  lt propertyfile gt  to edit that content later on    Example    lt echo file  build properties  gt    Default Configuration source dir 1 dir publish 1   Source Configuration dir publish html 1  lt  echo gt     Create separate properties files for each section  You re allowed a comment header for each type  Then  use  to batch them together into one single file    Example    lt propertyfile file  default properties      comment  Default Configuration  gt       lt entry key  source dir  value  1   gt       lt entry key  dir publish  value  1   gt   lt propertyfile gt    lt propertyfile file  source properties      comment  Source Configuration  gt       lt entry key  dir publish html  value  1   gt   lt propertyfile gt   lt concat destfile  build properties  gt       lt fileset dir    basedir   gt           lt include name  default properties   gt           lt include name  source properties   gt       lt  fileset gt   lt  concat gt    lt delete gt       lt fileset dir    basedir   gt            lt include name  default properties   gt           lt include name  source properties   gt       lt  fileset gt   lt  delete gt

User · Answer

Writing the properties file with multiple comments is not supported  Why    PropertyFile java  public class PropertyFile extends Task                                                                                                  Instance variables                  Use this to prepend a message to the properties file     private String              comment       private Properties          properties    The ant property file task is backed by a java util Properties class which  stores comments using the store   method  Only one comment is taken from the task and that is passed on to the Properties class to save into the file   The way to get around this is to write your own task that is backed by commons properties instead of java util Properties  The commons properties file is backed by a property layout which allows settings comments for individual keys in the properties file  Save the properties file with the save   method and modify the new task to accept multiple comments through   lt comment gt  elements

User · Answer

According to the documentation of the PropertyFile task  you can append the generated properties to an existing file  You could have a properties file with just the comment line  and have the Ant task append the generated properties

[java] adding comment in .properties files

Examples related to java

Examples related to ant

Examples related to properties-file