FormatUtils (nifi-utils 0.7.1 API)

java.lang.Object
- org.apache.nifi.util.FormatUtils

```
public class FormatUtils
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`private static double`	`BYTES_IN_GIGABYTE`
`private static double`	`BYTES_IN_KILOBYTE`
`private static double`	`BYTES_IN_MEGABYTE`
`private static double`	`BYTES_IN_TERABYTE`
`private static String`	`DAYS`
`private static String`	`HOURS`
`private static String`	`MILLIS`
`private static String`	`MINS`
`private static String`	`NANOS`
`private static String`	`SECS`
`static Pattern`	`TIME_DURATION_PATTERN`
`static String`	`TIME_DURATION_REGEX`
`private static String`	`UNION`
`private static String`	`VALID_TIME_UNITS`
`private static String`	`WEEKS`

Constructor Summary

Constructors
Constructor and Description

FormatUtils()

Constructors
Constructor and Description
`FormatUtils()`

Method Summary

Methods
Modifier and Type	Method and Description
`static String`	`formatCount(long count)` Formats the specified count by adding commas.
`static String`	`formatDataSize(double dataSize)` Formats the specified data size in human readable format.
`static String`	`formatHoursMinutesSeconds(long sourceDuration, TimeUnit sourceUnit)` Formats the specified duration in 'HH:mm:ss.SSS' format.
`static String`	`formatMinutesSeconds(long sourceDuration, TimeUnit sourceUnit)` Formats the specified duration in 'mm:ss.SSS' format.
`static String`	`formatUtilization(double utilization)`
`static long`	`getTimeDuration(String value, TimeUnit desiredUnit)`
`private static String`	`join(String delimiter, String... values)`
`private static String`	`pad(int val)`

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

Field Detail

UNION
```
private static final String UNION
```
See Also:
Constant Field Values

BYTES_IN_KILOBYTE
```
private static final double BYTES_IN_KILOBYTE
```
See Also:
Constant Field Values

BYTES_IN_MEGABYTE
```
private static final double BYTES_IN_MEGABYTE
```
See Also:
Constant Field Values

BYTES_IN_GIGABYTE
```
private static final double BYTES_IN_GIGABYTE
```
See Also:
Constant Field Values

BYTES_IN_TERABYTE
```
private static final double BYTES_IN_TERABYTE
```
See Also:
Constant Field Values

NANOS
```
private static final String NANOS
```

MILLIS
```
private static final String MILLIS
```

SECS
```
private static final String SECS
```

MINS
```
private static final String MINS
```

HOURS
```
private static final String HOURS
```

DAYS
```
private static final String DAYS
```

WEEKS
```
private static final String WEEKS
```

VALID_TIME_UNITS

private static final String VALID_TIME_UNITS

TIME_DURATION_REGEX

public static final String TIME_DURATION_REGEX

TIME_DURATION_PATTERN

public static final Pattern TIME_DURATION_PATTERN

Constructor Detail
- FormatUtils
```
public FormatUtils()
```

Method Detail
- formatCount
```
public static String formatCount(long count)
```
  Formats the specified count by adding commas.
  
  Parameters:
  count - the value to add commas to
  
  Returns:
  the string representation of the given value with commas included
- formatMinutesSeconds
```
public static String formatMinutesSeconds(long sourceDuration,
                          TimeUnit sourceUnit)
```
  Formats the specified duration in 'mm:ss.SSS' format.
  
  Parameters:
  sourceDuration - the duration to format
  sourceUnit - the unit to interpret the duration
  
  Returns:
  representation of the given time data in minutes/seconds
- formatHoursMinutesSeconds
```
public static String formatHoursMinutesSeconds(long sourceDuration,
                               TimeUnit sourceUnit)
```
  Formats the specified duration in 'HH:mm:ss.SSS' format.
  
  Parameters:
  sourceDuration - the duration to format
  sourceUnit - the unit to interpret the duration
  
  Returns:
  representation of the given time data in hours/minutes/seconds
- pad
```
private static String pad(int val)
```
- formatDataSize
```
public static String formatDataSize(double dataSize)
```
  Formats the specified data size in human readable format.
  
  Parameters:
  dataSize - Data size in bytes
  
  Returns:
  Human readable format
- getTimeDuration
```
public static long getTimeDuration(String value,
                   TimeUnit desiredUnit)
```
- formatUtilization
```
public static String formatUtilization(double utilization)
```
- join
```
private static String join(String delimiter,
          String... values)
```

Class FormatUtils

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNION

BYTES_IN_KILOBYTE

BYTES_IN_MEGABYTE

BYTES_IN_GIGABYTE

BYTES_IN_TERABYTE

NANOS

MILLIS

SECS

MINS

HOURS

DAYS

WEEKS

VALID_TIME_UNITS

TIME_DURATION_REGEX

TIME_DURATION_PATTERN

Constructor Detail

FormatUtils

Method Detail

formatCount

formatMinutesSeconds

formatHoursMinutesSeconds

pad

formatDataSize

getTimeDuration

formatUtilization

join