FormatUtil (oshi-core 3.4.2 API)

java.lang.Object
- oshi.util.FormatUtil

```
public class FormatUtil
extends Object
```
Formatting utility for appending units or converting between number types.

Author:

dblock[at]dblock[dot]org

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`formatBytes(long bytes)` Format bytes into a rounded string representation using IEC standard (matches Mac/Linux).
`static String`	`formatBytesDecimal(long bytes)` Format bytes into a rounded string representation using decimal SI units.
`static String`	`formatDate(org.threeten.bp.LocalDate date)` Convert a java date to a MM-dd-yyyy string representation
`static String`	`formatElapsedSecs(long secs)` Formats an elapsed time in seconds as days, hh:mm:ss.
`static String`	`formatHertz(long hertz)` Format hertz into a string to a rounded string representation.
`static org.threeten.bp.LocalDate`	`formatStringDate(String date)` Convert a MM-dd-yyyy string representation to a java LocalDate
`static String`	`formatValue(long value, String unit)` Format arbitrary units into a string to a rounded string representation.
`static long`	`getUnsignedInt(int x)` Convert unsigned int to signed long.
`static String`	`join(CharSequence delimiter, CharSequence... elements)` Returns a new String composed of copies of the CharSequence elements joined together with a copy of the specified delimiter.
`static String`	`join(CharSequence delimiter, Iterable<? extends CharSequence> elements)` Returns a new String composed of copies of the CharSequence elements joined together with a copy of the specified delimiter.
`static float`	`round(float d, int decimalPlace)` Round to certain number of decimals.
`static String`	`toUnsignedString(int i)` Represent a 32 bit value as if it were an unsigned integer.
`static String`	`toUnsignedString(long l)` Represent a 64 bit value as if it were an unsigned long.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - formatBytes
```
public static String formatBytes(long bytes)
```
    Format bytes into a rounded string representation using IEC standard (matches Mac/Linux). For hard drive capacities, use @link formatBytesDecimal(long). For Windows displays for KB, MB and GB, in JEDEC units, edit the returned string to remove the 'i' to display the (incorrect) JEDEC units.
    
    Parameters:
    
    bytes - Bytes.
    
    Returns:
    
    Rounded string representation of the byte size.
  - formatBytesDecimal
```
public static String formatBytesDecimal(long bytes)
```
    Format bytes into a rounded string representation using decimal SI units. These are used by hard drive manufacturers for capacity. Most other storage should use formatBytes(long).
    
    Parameters:
    
    bytes - Bytes.
    
    Returns:
    
    Rounded string representation of the byte size.
  - formatHertz
```
public static String formatHertz(long hertz)
```
    Format hertz into a string to a rounded string representation.
    
    Parameters:
    
    hertz - Hertz.
    
    Returns:
    
    Rounded string representation of the hertz size.
  - formatValue
```
public static String formatValue(long value,
                                 String unit)
```
    Format arbitrary units into a string to a rounded string representation.
    
    Parameters:
    
    value - The value
    
    unit - Units to append metric prefix to
    
    Returns:
    
    Rounded string representation of the value with metric prefix to extension
  - formatElapsedSecs
```
public static String formatElapsedSecs(long secs)
```
    Formats an elapsed time in seconds as days, hh:mm:ss.
    
    Parameters:
    
    secs - Elapsed seconds
    
    Returns:
    
    A string representation of elapsed time
  - round
```
public static float round(float d,
                          int decimalPlace)
```
    Round to certain number of decimals.
    
    Parameters:
    
    d - Number to be rounded
    
    decimalPlace - Number of decimal places to round to
    
    Returns:
    
    rounded result
  - getUnsignedInt
```
public static long getUnsignedInt(int x)
```
    Convert unsigned int to signed long.
    
    Parameters:
    
    x - Signed int representing an unsigned integer
    
    Returns:
    
    long value of x unsigned
  - formatDate
```
public static String formatDate(org.threeten.bp.LocalDate date)
```
    Convert a java date to a MM-dd-yyyy string representation
    
    Parameters:
    
    date - the date to convert
    
    Returns:
    
    a string in the form MM/dd/yyyy
  - formatStringDate
```
public static org.threeten.bp.LocalDate formatStringDate(String date)
```
    Convert a MM-dd-yyyy string representation to a java LocalDate
    
    Parameters:
    
    date - a string in the form MM/dd/yyyy
    
    Returns:
    
    the corresponding LocalDate
  - toUnsignedString
```
public static String toUnsignedString(int i)
```
    Represent a 32 bit value as if it were an unsigned integer. This is a Java 7 implementation of Java 8's Integer.toUnsignedString.
    
    Parameters:
    
    i - a 32 bit value
    
    Returns:
    
    the string representation of the unsigned integer
  - toUnsignedString
```
public static String toUnsignedString(long l)
```
    Represent a 64 bit value as if it were an unsigned long. This is a Java 7 implementation of Java 8's Long.toUnsignedString.
    
    Parameters:
    
    l - a 64 bit value
    
    Returns:
    
    the string representation of the unsigned long
  - join
```
public static String join(CharSequence delimiter,
                          CharSequence... elements)
```
    Returns a new String composed of copies of the CharSequence elements joined together with a copy of the specified delimiter. This is a Java 7 implementation of Java 8's String.join
    
    Parameters:
    
    delimiter - the delimiter that separates each element
    
    elements - the elements to join together.
    
    Returns:
    
    a new String that is composed of the elements separated by the delimiter
  - join
```
public static String join(CharSequence delimiter,
                          Iterable<? extends CharSequence> elements)
```
    Returns a new String composed of copies of the CharSequence elements joined together with a copy of the specified delimiter. This is a Java 7 implementation of Java 8's String.join
    
    Parameters:
    
    delimiter - a sequence of characters that is used to separate each of the elements in the resulting String
    
    elements - an Iterable that will have its elements joined together.
    
    Returns:
    
    a new String that is composed from the elements argument

Class FormatUtil

Method Summary

Methods inherited from class java.lang.Object

Method Detail

formatBytes

formatBytesDecimal

formatHertz

formatValue

formatElapsedSecs

round

getUnsignedInt

formatDate

formatStringDate

toUnsignedString

toUnsignedString

join

join