blob: 13a959e6fcdd5a34b045d6865d3a7f461657f0e7 [file] [log] [blame]
/*
* Copyright (C) 2006 The Android Open Source Project
*
* Licensed under the Apache 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.apache.org/licenses/LICENSE-2.0
*
* 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 android.text.format;
import android.content.Context;
import android.content.res.Resources;
import android.net.NetworkUtils;
import android.net.TrafficStats;
/**
* Utility class to aid in formatting common values that are not covered
* by the {@link java.util.Formatter} class in {@link java.util}
*/
public final class Formatter {
/** {@hide} */
public static final int FLAG_SHORTER = 1 << 0;
/** {@hide} */
public static final int FLAG_CALCULATE_ROUNDED = 1 << 1;
/** {@hide} */
public static class BytesResult {
public final String value;
public final String units;
public final long roundedBytes;
public BytesResult(String value, String units, long roundedBytes) {
this.value = value;
this.units = units;
this.roundedBytes = roundedBytes;
}
}
/**
* Formats a content size to be in the form of bytes, kilobytes, megabytes, etc
*
* @param context Context to use to load the localized units
* @param sizeBytes size value to be formatted, in bytes
* @return formatted string with the number
*/
public static String formatFileSize(Context context, long sizeBytes) {
final BytesResult res = formatBytes(context.getResources(), sizeBytes, 0);
return context.getString(com.android.internal.R.string.fileSizeSuffix,
res.value, res.units);
}
/**
* Like {@link #formatFileSize}, but trying to generate shorter numbers
* (showing fewer digits of precision).
*/
public static String formatShortFileSize(Context context, long sizeBytes) {
final BytesResult res = formatBytes(context.getResources(), sizeBytes, FLAG_SHORTER);
return context.getString(com.android.internal.R.string.fileSizeSuffix,
res.value, res.units);
}
/** {@hide} */
public static BytesResult formatBytes(Resources res, long sizeBytes, int flags) {
float result = sizeBytes;
int suffix = com.android.internal.R.string.byteShort;
long mult = 1;
if (result > 900) {
suffix = com.android.internal.R.string.kilobyteShort;
mult = TrafficStats.KB_IN_BYTES;
result = result / 1024;
}
if (result > 900) {
suffix = com.android.internal.R.string.megabyteShort;
mult = TrafficStats.MB_IN_BYTES;
result = result / 1024;
}
if (result > 900) {
suffix = com.android.internal.R.string.gigabyteShort;
mult = TrafficStats.GB_IN_BYTES;
result = result / 1024;
}
if (result > 900) {
suffix = com.android.internal.R.string.terabyteShort;
mult = TrafficStats.TB_IN_BYTES;
result = result / 1024;
}
if (result > 900) {
suffix = com.android.internal.R.string.petabyteShort;
mult = TrafficStats.PB_IN_BYTES;
result = result / 1024;
}
String value;
if (result < 1) {
value = String.format("%.2f", result);
} else if (result < 10) {
if ((flags & FLAG_SHORTER) != 0) {
value = String.format("%.1f", result);
} else {
value = String.format("%.2f", result);
}
} else if (result < 100) {
if ((flags & FLAG_SHORTER) != 0) {
value = String.format("%.0f", result);
} else {
value = String.format("%.2f", result);
}
} else {
value = String.format("%.0f", result);
}
final String units = res.getString(suffix);
final long roundedBytes;
if ((flags & FLAG_CALCULATE_ROUNDED) != 0) {
roundedBytes = (long) (Double.parseDouble(value) * mult);
} else {
roundedBytes = 0;
}
return new BytesResult(value, units, roundedBytes);
}
/**
* Returns a string in the canonical IPv4 format ###.###.###.### from a packed integer
* containing the IP address. The IPv4 address is expected to be in little-endian
* format (LSB first). That is, 0x01020304 will return "4.3.2.1".
*
* @deprecated Use {@link java.net.InetAddress#getHostAddress()}, which supports both IPv4 and
* IPv6 addresses. This method does not support IPv6 addresses.
*/
@Deprecated
public static String formatIpAddress(int ipv4Address) {
return NetworkUtils.intToInetAddress(ipv4Address).getHostAddress();
}
private static final int SECONDS_PER_MINUTE = 60;
private static final int SECONDS_PER_HOUR = 60 * 60;
private static final int SECONDS_PER_DAY = 24 * 60 * 60;
private static final int MILLIS_PER_MINUTE = 1000 * 60;
/**
* Returns elapsed time for the given millis, in the following format:
* 1 day 5 hrs; will include at most two units, can go down to seconds precision.
* @param context the application context
* @param millis the elapsed time in milli seconds
* @return the formatted elapsed time
* @hide
*/
public static String formatShortElapsedTime(Context context, long millis) {
long secondsLong = millis / 1000;
int days = 0, hours = 0, minutes = 0;
if (secondsLong >= SECONDS_PER_DAY) {
days = (int)(secondsLong / SECONDS_PER_DAY);
secondsLong -= days * SECONDS_PER_DAY;
}
if (secondsLong >= SECONDS_PER_HOUR) {
hours = (int)(secondsLong / SECONDS_PER_HOUR);
secondsLong -= hours * SECONDS_PER_HOUR;
}
if (secondsLong >= SECONDS_PER_MINUTE) {
minutes = (int)(secondsLong / SECONDS_PER_MINUTE);
secondsLong -= minutes * SECONDS_PER_MINUTE;
}
int seconds = (int)secondsLong;
if (days >= 2) {
days += (hours+12)/24;
return context.getString(com.android.internal.R.string.durationDays, days);
} else if (days > 0) {
if (hours == 1) {
return context.getString(com.android.internal.R.string.durationDayHour, days, hours);
}
return context.getString(com.android.internal.R.string.durationDayHours, days, hours);
} else if (hours >= 2) {
hours += (minutes+30)/60;
return context.getString(com.android.internal.R.string.durationHours, hours);
} else if (hours > 0) {
if (minutes == 1) {
return context.getString(com.android.internal.R.string.durationHourMinute, hours,
minutes);
}
return context.getString(com.android.internal.R.string.durationHourMinutes, hours,
minutes);
} else if (minutes >= 2) {
minutes += (seconds+30)/60;
return context.getString(com.android.internal.R.string.durationMinutes, minutes);
} else if (minutes > 0) {
if (seconds == 1) {
return context.getString(com.android.internal.R.string.durationMinuteSecond, minutes,
seconds);
}
return context.getString(com.android.internal.R.string.durationMinuteSeconds, minutes,
seconds);
} else if (seconds == 1) {
return context.getString(com.android.internal.R.string.durationSecond, seconds);
} else {
return context.getString(com.android.internal.R.string.durationSeconds, seconds);
}
}
/**
* Returns elapsed time for the given millis, in the following format:
* 1 day 5 hrs; will include at most two units, can go down to minutes precision.
* @param context the application context
* @param millis the elapsed time in milli seconds
* @return the formatted elapsed time
* @hide
*/
public static String formatShortElapsedTimeRoundingUpToMinutes(Context context, long millis) {
long minutesRoundedUp = (millis + MILLIS_PER_MINUTE - 1) / MILLIS_PER_MINUTE;
if (minutesRoundedUp == 0) {
return context.getString(com.android.internal.R.string.durationMinutes, 0);
} else if (minutesRoundedUp == 1) {
return context.getString(com.android.internal.R.string.durationMinute, 1);
}
return formatShortElapsedTime(context, minutesRoundedUp * MILLIS_PER_MINUTE);
}
}