1.1 restoration
[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  any library licensed under the Apache Software License, 
22  * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library 
23  * (or with modified versions of the above that use the same license as the above), 
24  * and distribute linked combinations including the two.  You must obey the 
25  * GNU General Public License in all respects for all of the code used other than 
26  * the above mentioned libraries.  If you modify this file, you may extend this 
27  * exception to your version of the file, but you are not obligated to do so.  
28  * If you do not wish to do so, delete this exception statement from your version.
29  */
30 package  mir.misc;
31
32 import java.text.NumberFormat;
33
34 /**
35  * Help methods for number handling.
36  *
37  * @version $Id: NumberUtils.java,v 1.5 2003/04/21 12:42:52 idfx Exp $
38  * @author mh, Mir-coders group
39  *
40  */
41
42 public final class NumberUtils {
43
44   /* 
45    * Uses a suffix indicating multiples of 1024 (K), 
46    * 1024*1024 (M), and 1024*1024*1024 (G).  For example, 
47    * 8500 would be converted to 8.3K, 133456345 to 
48    * 127M, 56990456345 to 53G, and so on.  Numbers 
49    * smaller than 1024 aren't modified.
50    *
51    * @param bytes The number of bytes.
52    * @return A text representation of the number of bytes,
53    *     abbreviated for larger quantities.
54    */
55   public static String humanReadableSize(double bytes)
56   {
57     String suffix;
58       
59     if( bytes >= 1024 * 1024 * 1024 )
60     {
61       bytes /= (1024 * 1024 * 1024);
62       suffix = "G";
63     }
64     else if( bytes >= 1024 * 1024 )
65     {
66       bytes /= (1024 * 1024);
67       suffix = "M";
68     }
69     else if( bytes >= 1024 )
70     {
71       bytes /= 1024;
72       suffix = "K";
73     }
74     else
75     {
76       suffix = "";
77     }
78     int frac = (bytes >= 10  ||  bytes == 0)  ?  0  :  1;
79     NumberFormat nf = NumberFormat.getInstance();
80     nf.setMinimumFractionDigits(frac);
81     nf.setMaximumFractionDigits(frac);
82     nf.setGroupingUsed(false);
83     return nf.format(bytes) + suffix;
84   }
85
86 }
87