All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.kuali.common.util.FormatUtils Maven / Gradle / Ivy

There is a newer version: 4.4.17
Show newest version
/**
 * Copyright 2010-2013 The Kuali Foundation
 *
 * Licensed under the Educational Community License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.opensource.org/licenses/ecl2.php
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.kuali.common.util;

import java.text.NumberFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Date;
import java.util.List;

import org.apache.commons.lang3.StringUtils;

/**
 * Format time, bytes, counts, dates, and transfer rates into human friendly form
 * 
 * @author Jeff Caddel
 * @since May 27, 2010 6:46:17 PM
 */
public class FormatUtils {

	public static final double SECOND = 1000;
	public static final double MINUTE = 60 * SECOND;
	public static final double HOUR = 60 * MINUTE;
	public static final double DAY = 24 * HOUR;
	public static final double YEAR = 365 * DAY;

	private static final String DATE_FORMAT = "yyyy-MM-dd'T'HH:mm:ss.SSSZZZZZ";

	private static final List TIME_TOKENS = Arrays.asList("ms", "s", "m", "h", "d", "y");
	private static final List TIME_MULTIPLIERS = getTimeMultipliers();

	private static final List SIZE_TOKENS = Arrays.asList("b", "k", "m", "g", "t", "p", "e");
	private static final int BASE = 1024;

	private static NumberFormat largeSizeFormatter = NumberFormat.getInstance();
	private static NumberFormat sizeFormatter = NumberFormat.getInstance();
	private static NumberFormat timeFormatter = NumberFormat.getInstance();
	private static NumberFormat rateFormatter = NumberFormat.getInstance();
	private static NumberFormat countFormatter = NumberFormat.getInstance();

	static {
		sizeFormatter.setGroupingUsed(false);
		sizeFormatter.setMaximumFractionDigits(1);
		sizeFormatter.setMinimumFractionDigits(1);
		largeSizeFormatter.setGroupingUsed(false);
		largeSizeFormatter.setMaximumFractionDigits(3);
		largeSizeFormatter.setMinimumFractionDigits(3);
		timeFormatter.setGroupingUsed(false);
		timeFormatter.setMaximumFractionDigits(3);
		timeFormatter.setMinimumFractionDigits(3);
		rateFormatter.setGroupingUsed(false);
		rateFormatter.setMaximumFractionDigits(3);
		rateFormatter.setMinimumFractionDigits(3);
		countFormatter.setGroupingUsed(true);
		countFormatter.setMaximumFractionDigits(0);
		countFormatter.setMinimumFractionDigits(0);
	}

	/**
	 * Parse bytes from a size string that ends with a unit of measure. If no unit of measure is provided, bytes is assumed. Unit of measure is case insensitive.
	 * 
	 * 
	 *   1  == 1 byte
	 *   1b == 1 byte
	 *   1k == 1 kilobyte == 1024   bytes ==                     1,024 bytes
	 *   1m == 1 megabyte == 1024^2 bytes ==                 1,048,576 bytes
	 *   1g == 1 gigabyte == 1024^3 bytes ==             1,073,741,824 bytes
	 *   1t == 1 terabyte == 1024^4 bytes ==         1,099,511,627,776 bytes
	 *   1p == 1 petabyte == 1024^5 bytes ==     1,125,899,906,842,624 bytes
	 *   1e == 1 exabyte  == 1024^6 bytes == 1,152,921,504,606,846,976 bytes
	 * 
*/ public static long getBytes(String size) { return getBytes(size, SIZE_TOKENS, BASE); } public static long getBytes(String size, List tokens, int base) { Assert.notBlank(size); for (int i = 0; i < tokens.size(); i++) { String token = tokens.get(i); long multiplier = (long) Math.pow(base, i); if (StringUtils.endsWithIgnoreCase(size, token)) { return getByteValue(size, token, multiplier); } } // Assume bytes return getByteValue(size, "", 1); } protected static long getByteValue(String time, String suffix, long multiplier) { int len = StringUtils.length(time); String substring = StringUtils.substring(time, 0, len - suffix.length()); Double value = new Double(substring); value = value * multiplier; return value.longValue(); } /** * Parse milliseconds from a time string that ends with a unit of measure. If no unit of measure is provided, milliseconds is assumed. Unit of measure is case insensitive. * *
	 *   1   == 1 millisecond
	 *   1ms == 1 millisecond
	 *   1s  == 1 second ==           1000 milliseconds
	 *   1m  == 1 minute ==         60,000 milliseconds
	 *   1h  == 1 hour   ==      3,600,000 milliseconds 
	 *   1d  == 1 day    ==     86,400,000 milliseconds
	 *   1y  == 1 year   == 31,536,000,000 milliseconds
	 * 
*/ public static long getMillis(String time) { return getMillis(time, TIME_TOKENS, TIME_MULTIPLIERS); } public static long getMillis(String time, List tokens, List multipliers) { Assert.notBlank(time); Assert.isTrue(tokens.size() == multipliers.size()); for (int i = 0; i < tokens.size(); i++) { String token = tokens.get(i); long multiplier = multipliers.get(i); if (StringUtils.endsWithIgnoreCase(time, token)) { return getTimeValue(time, token, multiplier); } } // Assume milliseconds return getTimeValue(time, "", 1); } protected static long getTimeValue(String time, String suffix, long multiplier) { int len = StringUtils.length(time); String substring = StringUtils.substring(time, 0, len - suffix.length()); Double value = new Double(substring); value = value * multiplier; return value.longValue(); } /** * Parse a date from the string. The string must be in the same format returned by the getDate() methods */ public static Date parseDate(String date) { try { // New object every time because SimpleDateFormat isn't threadsafe SimpleDateFormat sdf = new SimpleDateFormat(DATE_FORMAT); return sdf.parse(date); } catch (ParseException e) { throw new IllegalArgumentException("Can't parse [" + date + "]", e); } } /** * Return a formatted date */ public static String getDate(long millis) { return getDate(new Date(millis)); } /** * Return a formatted date */ public static String getDate(Date date) { // New object every time because SimpleDateFormat isn't threadsafe SimpleDateFormat sdf = new SimpleDateFormat(DATE_FORMAT); return sdf.format(date); } /** * */ public static String getThroughputInSeconds(long millis, long count, String label) { double seconds = millis / SECOND; double countPerSecond = count / seconds; return countFormatter.format(countPerSecond) + " " + label; } /** * Given a number of bytes and the number of milliseconds it took to transfer that number of bytes, return bytes/s, KB/s, MB/s, GB/s, TB/s, PB/s, or EB/s as appropriate */ public static String getRate(long millis, long bytes) { double seconds = millis / SECOND; double bytesPerSecond = bytes / seconds; Size bandwidthLevel = getSizeEnum(bytesPerSecond); double transferRate = bytesPerSecond / bandwidthLevel.getValue(); return rateFormatter.format(transferRate) + " " + bandwidthLevel.getRateLabel(); } /** * Return a formatted count */ public static String getCount(long count) { return countFormatter.format(count); } /** * Given milliseconds, return milliseconds, seconds, minutes, hours, days, or years as appropriate. Note that years is approximate since the logic always assumes there are * exactly 365 days per year. */ public static String getTime(long millis) { long abs = Math.abs(millis); if (abs < SECOND) { return millis + "ms"; } else if (abs < MINUTE) { return timeFormatter.format(millis / SECOND) + "s"; } else if (abs < HOUR) { return timeFormatter.format(millis / MINUTE) + "m"; } else if (abs < DAY) { return timeFormatter.format(millis / HOUR) + "h"; } else if (abs < YEAR) { return timeFormatter.format(millis / DAY) + "d"; } else { return timeFormatter.format(millis / YEAR) + "y"; } } /** * Given a number of bytes return bytes, kilobytes, megabytes, gigabytes, terabytes, petabytes, or exabytes as appropriate. */ public static String getSize(long bytes) { return getSize(bytes, null); } /** * Given a number of bytes return a string formatted into the unit of measure indicated */ public static String getSize(long bytes, Size unitOfMeasure) { unitOfMeasure = (unitOfMeasure == null) ? getSizeEnum(bytes) : unitOfMeasure; StringBuilder sb = new StringBuilder(); sb.append(getFormattedSize(bytes, unitOfMeasure)); sb.append(unitOfMeasure.getSizeLabel()); return sb.toString(); } public static String getFormattedSize(long bytes, Size size) { switch (size) { case BYTE: return bytes + ""; case KB: case MB: case GB: return sizeFormatter.format(bytes / (double) size.getValue()); default: return largeSizeFormatter.format(bytes / (double) size.getValue()); } } public static Size getSizeEnum(double bytes) { bytes = Math.abs(bytes); if (bytes < Size.KB.getValue()) { return Size.BYTE; } else if (bytes < Size.MB.getValue()) { return Size.KB; } else if (bytes < Size.GB.getValue()) { return Size.MB; } else if (bytes < Size.TB.getValue()) { return Size.GB; } else if (bytes < Size.PB.getValue()) { return Size.TB; } else if (bytes < Size.EB.getValue()) { return Size.PB; } else { return Size.EB; } } protected static final List getTimeMultipliers() { List m = new ArrayList(); m.add(1L); m.add(new Double(SECOND).longValue()); m.add(new Double(MINUTE).longValue()); m.add(new Double(HOUR).longValue()); m.add(new Double(DAY).longValue()); m.add(new Double(YEAR).longValue()); return m; } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy