one.microstream.configuration.types

Interface ByteSizeParser

All Known Implementing Classes:

ByteSizeParser.Default

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ByteSizeParser

Parser for ByteSizes out of textual representation.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ByteSizeParser.Default

Method Summary

Modifier and Type	Method and Description
static ByteSizeParser	New() Preudo-constructor method to create a new ByteSizeParser.
static ByteSizeParser	New(ByteUnit defaultUnit) Preudo-constructor method to create a new ByteSizeParser.
ByteSize	parse(String text) Tries to parse a ByteSize out of text.

Method Detail

parse

ByteSize parse(String text)

Tries to parse a ByteSize out of text. It usually consists of an amount and an unit, e.g. "1MB" or "1.2 GB".

Parameters:

text - the textual input

Returns:

the parsed ByteSize

Throws:

IllegalArgumentException - if the text couldn't be parsed to a ByteSize

See Also:

ByteSize, ByteUnit

New

static ByteSizeParser New()

Preudo-constructor method to create a new ByteSizeParser.

Returns:

a new ByteSizeParser

New

static ByteSizeParser New(ByteUnit defaultUnit)

Preudo-constructor method to create a new ByteSizeParser.

Parameters:

defaultUnit - the default unit which is used if no unit is given in the input

Returns:

a new ByteSizeParser