Add filter for concise numbers (three most significant digits only).
[demoscenemusic.git] / src / main / java / net / pterodactylus / demoscenemusic / template / ConciseNumberFilter.java
1 /*
2  * DemosceneMusic - ConciseNumberFilter.java - Copyright © 2012 David Roden
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation, either version 3 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
16  */
17
18 package net.pterodactylus.demoscenemusic.template;
19
20 import java.util.Arrays;
21 import java.util.List;
22 import java.util.Map;
23
24 import net.pterodactylus.util.number.Numbers;
25 import net.pterodactylus.util.template.Filter;
26 import net.pterodactylus.util.template.TemplateContext;
27
28 /**
29  * {@link Filter} implementation that only shows the three most significant
30  * digits of a number, adding prefix for kilo (kibi, actually), mega (mebi), et
31  * cetera, as necessary.
32  *
33  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
34  */
35 public class ConciseNumberFilter implements Filter {
36
37         private static final List<String> prefixes = Arrays.asList("", "Ki", "Mi", "Gi", "Ti", "Pi", "Ei");
38
39         /**
40          * {@inheritDoc}
41          */
42         @Override
43         public Object format(TemplateContext templateContext, Object data, Map<String, Object> parameters) {
44                 double number = Numbers.safeParseLong(data, 0L);
45                 int prefix = 0;
46                 while (number > 1023) {
47                         prefix++;
48                         number /= 1024.0;
49                 }
50                 if (number >= 1000) {
51                         return String.format("%1.2f %s", number / 1024.0, prefixes.get(prefix + 1));
52                 }
53                 if (number >= 100) {
54                         return String.format("%1.0f %s", number, prefixes.get(prefix));
55                 }
56                 if (number >= 10) {
57                         return String.format("%1.1f %s", number, prefixes.get(prefix));
58                 }
59                 return String.format("%1.2f %s", number, prefixes.get(prefix));
60         }
61
62 }