org.apache.brooklyn.util.text

Class ByteSizeStrings.Builder

java.lang.Object

org.apache.brooklyn.util.text.ByteSizeStrings.Builder

Enclosing class:

ByteSizeStrings

public static class ByteSizeStrings.Builder
extends java.lang.Object

Configures and builds a ByteSizeStrings formatter.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ByteSizeStrings.Builder	addSpace()
ByteSizeStrings.Builder	addSpace(boolean addSpace) Whether to add a space between the value and the unit suffix.
ByteSizeStrings	build() Returns an immutable ByteSizeStrings formatter using the builder configuration.
ByteSizeStrings.Builder	bytesPerMetricUnit(int bytesPerMetricUnit) The number of bytes per metric usnit, usually either 1000 or 1024.
ByteSizeStrings.Builder	lowerLimit(int lowerLimit) Prints using a lower suffix until the size is greater than this limit multiplied by bytes per metric unit, when the next highest suffix will be used.§
ByteSizeStrings.Builder	maxLen(int maxLen) The maximum length of the printed number.
ByteSizeStrings.Builder	noSpace()
ByteSizeStrings.Builder	precision(int precision) The number of digits accuracy desired in the printed number.
ByteSizeStrings.Builder	suffixBytes(java.lang.String suffixBytes) The suffix to use when printing bytes.
ByteSizeStrings.Builder	suffixGiga(java.lang.String suffixGiga) The suffix to use when printing Gigabytes.
ByteSizeStrings.Builder	suffixKilo(java.lang.String suffixKilo) The suffix to use when printing Kilobytes.
ByteSizeStrings.Builder	suffixMega(java.lang.String suffixMega) The suffix to use when printing Megabytes.
ByteSizeStrings.Builder	suffixTera(java.lang.String suffixTera) The suffix to use when printing Terabytes.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

suffixBytes

public ByteSizeStrings.Builder suffixBytes(java.lang.String suffixBytes)

The suffix to use when printing bytes.

suffixKilo

public ByteSizeStrings.Builder suffixKilo(java.lang.String suffixKilo)

The suffix to use when printing Kilobytes.

suffixMega

public ByteSizeStrings.Builder suffixMega(java.lang.String suffixMega)

The suffix to use when printing Megabytes.

suffixGiga

public ByteSizeStrings.Builder suffixGiga(java.lang.String suffixGiga)

The suffix to use when printing Gigabytes.

suffixTera

public ByteSizeStrings.Builder suffixTera(java.lang.String suffixTera)

The suffix to use when printing Terabytes.

addSpace

public ByteSizeStrings.Builder addSpace(boolean addSpace)

Whether to add a space between the value and the unit suffix.

Defaults is true for '5 MiB' output.

addSpace

public ByteSizeStrings.Builder addSpace()

noSpace

public ByteSizeStrings.Builder noSpace()

bytesPerMetricUnit

public ByteSizeStrings.Builder bytesPerMetricUnit(int bytesPerMetricUnit)

The number of bytes per metric usnit, usually either 1000 or 1024.

Used to determine when to use the next suffix string.

maxLen

public ByteSizeStrings.Builder maxLen(int maxLen)

The maximum length of the printed number.

See Also:

Strings.makeRealString(double, int, int, int, double, boolean)

precision

public ByteSizeStrings.Builder precision(int precision)

The number of digits accuracy desired in the printed number.

See Also:

Strings.makeRealString(double, int, int, int, double, boolean)

lowerLimit

public ByteSizeStrings.Builder lowerLimit(int lowerLimit)

Prints using a lower suffix until the size is greater than this limit multiplied by bytes per metric unit, when the next highest suffix will be used.§

If this has the value 5 then sizes up to 5000 will be printed as bytes, and over 5000 as Kilobytes.

build

public ByteSizeStrings build()

Returns an immutable ByteSizeStrings formatter using the builder configuration.