one.microstream.configuration.types

Interface DurationParser

All Known Implementing Classes:

DurationParser.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 DurationParser

Parser for Durations out of textual representation.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DurationParser.Default

Method Summary

Modifier and Type	Method and Description
static DurationParser	New() Pseudo-constructor method to create a new DurationParser, with DurationUnit.MS as default unit.
static DurationParser	New(DurationUnit defaultUnit) Pseudo-constructor method to create a new DurationParser.
Duration	parse(String text) Tries to parse a Duration out of text.

Method Detail

parse

Duration parse(String text)

Tries to parse a Duration out of text. It usually consists of an amount and an unit, e.g. "1S" or the ISO format, as described here Duration.parse(CharSequence).

Parameters:

text - the textual input

Returns:

the parsed Duration

Throws:

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

See Also:

DurationUnit

New

static DurationParser New()

Pseudo-constructor method to create a new DurationParser, with DurationUnit.MS as default unit.

Returns:

a new duraction parser

New

static DurationParser New(DurationUnit defaultUnit)

Pseudo-constructor method to create a new DurationParser.

Parameters:

defaultUnit - a custom default unit

Returns:

a new duraction parser