Pretty print convenience methods

README.md

@@ -274,6 +274,17 @@ buildscript {
 apply plugin: 'de.fuerstenau.buildconfig' // actually applies the plugin
 ```
 
+## Pretty printing
+The contents of BuildInfo can be printed, either directly to standard out via the method ```prettyPrint();``` or in a user defined way:
+```java
+de.fuerstenau.BuildInfo.prettyPrint((fields) ->
+{
+    for (final Field field : fields)
+        System.out.println("Name: " + field.getName());
+});
+```
+This allows one to conveniently render the full set of fields to XML, JSON, or write to a log, etc.
+
 ## Compatibility
 
 * Oracle JDK and OpenJDK 1.7 compatible,

src/main/groovy/de/fuerstenau/gradle/buildconfig/ClassWriter.groovy

@@ -31,17 +31,27 @@ class ClassWriter extends Writer
 
    private final Writer delegate
    private boolean isClass
+
+   private String pkg
+   private String cls
 
-   ClassWriter (Writer delegate)
+   ClassWriter (Writer delegate, String pkg, String cls)
    {
       this.delegate = delegate
+      this.pkg = pkg
+      this.cls = cls
    }
 
    ClassWriter writePackage (String pkg) throws IOException
    {
       if (isClass)
          throw new IllegalStateException ("cannot write package if class is already written")
-      delegate.write ("package ${pkg};\n\n")
+      delegate.write ("""package ${pkg};
+
+import java.util.List;
+import java.lang.reflect.Field;
+
+""")
       this
    }
 
@@ -98,7 +108,33 @@ class ClassWriter extends Writer
    public void close () throws IOException
    {
       if (isClass)
+      {
+         delegate.write("""   public interface PrettyPrinter
+   {
+      public void print(Field[] field);
+   }
+
+   public static void prettyPrint(PrettyPrinter printer)
+   {
+      printer.print(${pkg}.${cls}.class.getDeclaredFields());
+   }
+
+   public static void prettyPrint()
+   {
+      prettyPrint((fields) ->
+      {
+         for (final Field field : fields)
+            try
+            {
+               System.out.println(field.getName() + ": " + field.get(null));\n\
+            }
+            catch (IllegalArgumentException | IllegalAccessException ex)
+            {
+            }
+      });
+   }""")
          delegate.write ("}\n")
+      }
       delegate.close ()
    }
 

src/main/groovy/de/fuerstenau/gradle/buildconfig/GenerateBuildConfigTask.groovy

@@ -237,7 +237,7 @@ class GenerateBuildConfigTask extends DefaultTask
 
       new ClassWriter (
          Files.newBufferedWriter (outputFile, Charset.forName (charset),
-            StandardOpenOption.CREATE)).withCloseable { w ->
+            StandardOpenOption.CREATE), packageName, clsName).withCloseable { w ->
          w.writePackage (packageName).writeClass (clsName)
 
          mergedClassFields.values ().each { cf ->