ByteSizeStrings (Apache Brooklyn)

java.lang.Object
- org.apache.brooklyn.util.text.ByteSizeStrings

```
public class ByteSizeStrings
extends java.lang.Object
```
A formatter to pretty-print numeric values representing sizes in byes.
The builder() presents a fluent interface to create various configurations of formatting. The defaults produce metric units in multiples of 1000 bytes at a precision of three significant figures. This is the way disk space is normally measured, for example 128.1GB.
Alternatively the iso() convenience method produces ISO standard units in multiples of 1024 bytes, with the same precision as the metric output. This is how RAM is normally measured, for example 12.4MiB or 1.04GiB.
Finally, the java() convenience method will produce strings suitable for use with a Java command line, as part of the -Xms or -Xmx options. These output integer values only, so values up to 10GB will be reported in MB to preserve accuracy. For size values over 1000GB, the output will still be formatted as GB but rounded to a mutiple of 1000.
The class is immutable and thread safe once built and a single instance of the three pre-defined configurations is created and returned buy the methods described above.

See Also:

Strings.makeSizeString(long), Strings.makeISOSizeString(long), Strings.makeJavaSizeString(long)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ByteSizeStrings.Builder
Configures and builds a ByteSizeStrings formatter.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ByteSizeStrings.Builder` Configures and builds a `ByteSizeStrings` formatter.

Constructor Summary

Constructors
Constructor and Description

ByteSizeStrings()
Deprecated.
Use builder()

Constructors
Constructor and Description
`ByteSizeStrings()` Deprecated. Use `builder()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.String`	`apply(java.lang.Long input)` A `Function` implementation that formats its input using the current `ByteSizeStrings` values.
`static ByteSizeStrings.Builder`	`builder()` Returns a builder for a `ByteSizeStrings` formatter.
`java.util.Formattable`	`formatted(long bytes)` Returns a `Formattable` object that can be used with `String.format(String, Object...)`.
`static ByteSizeStrings`	`iso()` Formats byte sizes using ISO standard suffixes and binary multiples of 1024
`static ByteSizeStrings`	`java()` Format byte sizes suitable for Java `-Xms` arguments.
`java.lang.String`	`makeSizeString(long size)` Format the size bytes as a String.
`java.lang.String`	`makeSizeString(long size, int precision)` Format the size bytes as a String with the given precision.
`static ByteSizeStrings`	`metric()` Default byte size formatter using metric multiples of 1000.
`static long`	`parse(java.lang.String sizeString)`
`static long`	`parse(java.lang.String sizeString, java.lang.String defaultUnits)`
`static long`	`parse(java.lang.String sizeStringOriginal, java.lang.String defaultUnit, ByteSizeStrings bytesMode)` parses the given string as a byte size string, e.g.
`void`	`setBytesPerMetricUnit(int bytesPerMetricUnit)` Deprecated. Use `ByteSizeStrings.Builder.bytesPerMetricUnit(int)`
`void`	`setLowerLimit(int lowerLimit)` Deprecated. Use `ByteSizeStrings.Builder.lowerLimit(int)`
`void`	`setMaxLen(int maxLen)` Deprecated. Use `ByteSizeStrings.Builder.maxLen(int)`
`void`	`setPrecision(int precision)` Deprecated. Use `ByteSizeStrings.Builder.precision(int)`
`void`	`setSuffixBytes(java.lang.String suffixBytes)` Deprecated. Use `ByteSizeStrings.Builder.suffixBytes(String)`
`void`	`setSuffixGiga(java.lang.String suffixGiga)` Deprecated. Use `ByteSizeStrings.Builder.suffixGiga(String)`
`void`	`setSuffixKilo(java.lang.String suffixKilo)` Deprecated. Use `ByteSizeStrings.Builder.suffixKilo(String)`
`void`	`setSuffixMega(java.lang.String suffixMega)` Deprecated. Use `ByteSizeStrings.Builder.suffixMega(String)`
`void`	`setSuffixTera(java.lang.String suffixTera)` Deprecated. Use `ByteSizeStrings.Builder.suffixTera(String)`

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

- Constructor Detail
  - ByteSizeStrings
```
@Deprecated
public ByteSizeStrings()
```
    Deprecated. Use builder()
- Method Detail
  - builder
```
public static ByteSizeStrings.Builder builder()
```
    Returns a builder for a ByteSizeStrings formatter.
  - java
```
public static final ByteSizeStrings java()
```
    Format byte sizes suitable for Java -Xms arguments.
  - iso
```
public static ByteSizeStrings iso()
```
    Formats byte sizes using ISO standard suffixes and binary multiples of 1024
  - metric
```
public static ByteSizeStrings metric()
```
    Default byte size formatter using metric multiples of 1000.
  - setSuffixBytes
```
@Deprecated
public void setSuffixBytes(java.lang.String suffixBytes)
```
    Deprecated. Use ByteSizeStrings.Builder.suffixBytes(String)
  - setSuffixKilo
```
@Deprecated
public void setSuffixKilo(java.lang.String suffixKilo)
```
    Deprecated. Use ByteSizeStrings.Builder.suffixKilo(String)
  - setSuffixMega
```
@Deprecated
public void setSuffixMega(java.lang.String suffixMega)
```
    Deprecated. Use ByteSizeStrings.Builder.suffixMega(String)
  - setSuffixGiga
```
@Deprecated
public void setSuffixGiga(java.lang.String suffixGiga)
```
    Deprecated. Use ByteSizeStrings.Builder.suffixGiga(String)
  - setSuffixTera
```
@Deprecated
public void setSuffixTera(java.lang.String suffixTera)
```
    Deprecated. Use ByteSizeStrings.Builder.suffixTera(String)
  - setBytesPerMetricUnit
```
@Deprecated
public void setBytesPerMetricUnit(int bytesPerMetricUnit)
```
    Deprecated. Use ByteSizeStrings.Builder.bytesPerMetricUnit(int)
  - setMaxLen
```
@Deprecated
public void setMaxLen(int maxLen)
```
    Deprecated. Use ByteSizeStrings.Builder.maxLen(int)
  - setPrecision
```
@Deprecated
public void setPrecision(int precision)
```
    Deprecated. Use ByteSizeStrings.Builder.precision(int)
  - setLowerLimit
```
@Deprecated
public void setLowerLimit(int lowerLimit)
```
    Deprecated. Use ByteSizeStrings.Builder.lowerLimit(int)
  - makeSizeString
```
public java.lang.String makeSizeString(long size)
```
    Format the size bytes as a String.
  - makeSizeString
```
public java.lang.String makeSizeString(long size,
                                       int precision)
```
    Format the size bytes as a String with the given precision.
  - formatted
```
public java.util.Formattable formatted(long bytes)
```
    Returns a Formattable object that can be used with String.format(String, Object...).
    When used as the argument for a %s format string element, the bytes value will be formatted using the current ByteSizeStrings values, or if the alternative flag is set (using the %#s format string) it will use the metric() formatter. Finally, the precision of the formatted value can be adjusted using format string argumenbts like %.6s.
    
    See Also:
    
    http://docs.oracle.com/javase/7/docs/api/java/util/Formatter.html#syntax
  - apply
```
@Nullable
public java.lang.String apply(@Nullable
                                        java.lang.Long input)
```
    A Function implementation that formats its input using the current ByteSizeStrings values.
  - parse
```
public static long parse(java.lang.String sizeString)
```
  - parse
```
public static long parse(java.lang.String sizeString,
                         java.lang.String defaultUnits)
```
  - parse
```
public static long parse(java.lang.String sizeStringOriginal,
                         java.lang.String defaultUnit,
                         ByteSizeStrings bytesMode)
```
    parses the given string as a byte size string, e.g. "4gb"
    
    Parameters:
    
    sizeString - string to parse
    
    defaultUnit - optional units to append if a number (no units) are supplied
    
    bytesMode - optional evaluation mode to force 1024 or 1000 as the interpretation of the unit prefix; if omitted, it will depend on the units supplied, 1000 for metric() (e.g. "1kB"), and 1024 for java() (e.g. "1k") and iso() (e.g. "1KiB")
    
    Returns:
    
    number of bytes represented by this string

Class ByteSizeStrings

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ByteSizeStrings

Method Detail

builder

java

iso

metric

setSuffixBytes

setSuffixKilo

setSuffixMega

setSuffixGiga

setSuffixTera

setBytesPerMetricUnit

setMaxLen

setPrecision

setLowerLimit

makeSizeString

makeSizeString

formatted

apply

parse

parse

parse