[Pojomatic-commits] SF.net SVN: pojomatic:[81] trunk/Pojomatic/src/main/java/org/pojomatic/ formatter/DefaultPojoFormatter.java

[<iro...@us...>]

Revision: 81
          http://pojomatic.svn.sourceforge.net/pojomatic/?rev=81&view=rev
Author:   iroberts
Date:     2008-12-31 22:29:58 +0000 (Wed, 31 Dec 2008)

Log Message:
-----------
javadoc

Modified Paths:
--------------
    trunk/Pojomatic/src/main/java/org/pojomatic/formatter/DefaultPojoFormatter.java

Modified: trunk/Pojomatic/src/main/java/org/pojomatic/formatter/DefaultPojoFormatter.java
===================================================================
--- trunk/Pojomatic/src/main/java/org/pojomatic/formatter/DefaultPojoFormatter.java	2008-12-17 23:09:51 UTC (rev 80)
+++ trunk/Pojomatic/src/main/java/org/pojomatic/formatter/DefaultPojoFormatter.java	2008-12-31 22:29:58 UTC (rev 81)
@@ -4,9 +4,14 @@
 import org.pojomatic.PropertyElement;
 
 /**
- * Default formatter for classes that use {@link Pojomatic}.
- * For example,
- * TODO provide an example
+ * Default formatter for classes that use {@link Pojomatic}.  This implementation first presents
+ * the class name, and then each property in turn, separated by commas, using braces to indicate
+ * nesting.
+ * <p>
+ * For example, if a class Person has two properties, firstName and LastName, and these properties
+ * are using {@link DefaultPropertyFormatter}, then the Person
+ * instance representing Joe Blow would be represented as
+ * <code>"Person{firstName: {Joe}, lastName: {Blow}}"</code>
  */
 public class DefaultPojoFormatter implements PojoFormatter {
   private boolean firstPropertyPrinted = false;


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.