[Wonder-cvs] SF.net SVN: wonder:[11205] trunk/Wonder/Frameworks/Core/ERExtensions/ Sources/er/extensions/formatters/ERXTimeDurationFormatter.java

[<kel...@us...>]

Revision: 11205
          http://wonder.svn.sourceforge.net/wonder/?rev=11205&view=rev
Author:   kelleherk
Date:     2010-09-02 17:05:11 +0000 (Thu, 02 Sep 2010)

Log Message:
-----------
javadoc and convenience constructors.

Modified Paths:
--------------
    trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/formatters/ERXTimeDurationFormatter.java

Modified: trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/formatters/ERXTimeDurationFormatter.java
===================================================================
--- trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/formatters/ERXTimeDurationFormatter.java	2010-09-02 16:50:31 UTC (rev 11204)
+++ trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/formatters/ERXTimeDurationFormatter.java	2010-09-02 17:05:11 UTC (rev 11205)
@@ -8,20 +8,45 @@
 
 
 /**
+ * User-presentable time duration format as days, hours, minutes and seconds.
+ * 
  * @author kieran
  *
  */
 public class ERXTimeDurationFormatter extends NumberFormat {
-	private TimeUnit timeUnit = TimeUnit.SECONDS;
-	private boolean showLargestUnitOnly = false;
-	private boolean omitSecondsPart = false;
+	private final TimeUnit _timeUnit;
+	private final boolean _showLargestUnitOnly;
+	private final boolean _omitSecondsPart;
 	
+	
+	
+	/**
+	 * Defaults to TimeUnit.SECONDS, showing all time units and showing seconds part of the time description.
+	 */
+	public ERXTimeDurationFormatter() {
+		this(TimeUnit.SECONDS, false, false);
+	}
+	
+	/**
+	 * Defaults to showing all time units and showing seconds part of the time description.
+	 * 
+	 * @param timeUnit the unit of time which is milliseconds, seconds, etc.
+	 */
+	public ERXTimeDurationFormatter(TimeUnit timeUnit) {
+		this(timeUnit, false, false);
+	}
+	
+	/**
+	 * @param timeUnit the unit of time which is milliseconds, seconds, etc.
+	 * @param showLargestUnitOnly display the largest time unit (days, hours, minutes or seconds) that the time value rounds down to
+	 * @param omitSecondsPart imit the seconds unit from the format.
+	 */
 	public ERXTimeDurationFormatter(TimeUnit timeUnit, boolean showLargestUnitOnly, boolean omitSecondsPart) {
 		super();
 		
-		this.timeUnit = timeUnit;
-		this.showLargestUnitOnly = showLargestUnitOnly;
-		this.omitSecondsPart = false;
+		this._timeUnit = timeUnit;
+		this._showLargestUnitOnly = showLargestUnitOnly;
+		this._omitSecondsPart = omitSecondsPart;
 	}
 	
 
@@ -33,8 +58,8 @@
     
     @Override
 	public StringBuffer format(long number, StringBuffer toAppendTo, FieldPosition fieldPosition) {
-       long seconds = TimeUnit.SECONDS.convert(number, timeUnit);
-       return toAppendTo.append(timePeriodDescription(seconds, showLargestUnitOnly, omitSecondsPart));
+       long seconds = TimeUnit.SECONDS.convert(number, _timeUnit);
+       return toAppendTo.append(timePeriodDescription(seconds, _showLargestUnitOnly, _omitSecondsPart));
     }
 
     


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