number formatter routine. print raw sizes in bytes to a human readable format
[mir.git] / source / mir / misc / NumberUtils.java
1 /*
2  * Copyright (C) 2001, 2002  The Mir-coders group
3  *
4  * This file is part of Mir.
5  *
6  * Mir is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * Mir is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with Mir; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  *
20  * In addition, as a special exception, The Mir-coders gives permission to link
21  * the code of this program with the com.oreilly.servlet library, any library
22  * licensed under the Apache Software License, The Sun (tm) Java Advanced
23  * Imaging library (JAI), The Sun JIMI library (or with modified versions of
24  * the above that use the same license as the above), and distribute linked
25  * combinations including the two.  You must obey the GNU General Public
26  * License in all respects for all of the code used other than the above
27  * mentioned libraries.  If you modify this file, you may extend this exception
28  * to your version of the file, but you are not obligated to do so.  If you do
29  * not wish to do so, delete this exception statement from your version.
30  */
31
32 package  mir.misc;
33
34 import freemarker.template.*;
35
36 import java.text.NumberFormat;
37 import java.util.List; 
38
39 /**
40  * Help methods for number handling.
41  *
42  * @version $Id: NumberUtils.java,v 1.1.2.1 2002/11/28 05:54:54 mh Exp $
43  * @author mh, Mir-coders group
44  *
45  */
46
47 public final class NumberUtils {
48
49   /* 
50    * Uses a suffix indicating multiples of 1024 (K), 
51    * 1024*1024 (M), and 1024*1024*1024 (G).  For example, 
52    * 8500 would be converted to 8.3K, 133456345 to 
53    * 127M, 56990456345 to 53G, and so on.  Numbers 
54    * smaller than 1024 aren't modified.
55    *
56    * @param bytes The number of bytes.
57    * @return A text representation of the number of bytes,
58    *     abbreviated for larger quantities.
59    */
60   public static String humanReadableSize(double bytes)
61   {
62     String suffix;
63       
64     if( bytes >= 1024 * 1024 * 1024 )
65     {
66       bytes /= (1024 * 1024 * 1024);
67       suffix = "G";
68     }
69     else if( bytes >= 1024 * 1024 )
70     {
71       bytes /= (1024 * 1024);
72       suffix = "M";
73     }
74     else if( bytes >= 1024 )
75     {
76       bytes /= 1024;
77       suffix = "K";
78     }
79     else
80     {
81       suffix = "";
82     }
83     int frac = (bytes >= 10  ||  bytes == 0)  ?  0  :  1;
84     NumberFormat nf = NumberFormat.getInstance();
85     nf.setMinimumFractionDigits(frac);
86     nf.setMaximumFractionDigits(frac);
87     System.out.println(nf.getMinimumIntegerDigits());
88     nf.setGroupingUsed(false);
89     return nf.format(bytes) + suffix;
90   }
91
92 }
93