io.jmix.ui.app.propertyfilter.dateinterval.converter

Interface DateIntervalConverter

All Known Implementing Classes:

NextLastIntervalConverter, PredefinedIntervalConverter, RelativeIntervalConverter

public interface DateIntervalConverter

Interface provides methods for parsing/formating date interval values.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	INCLUDING_CURRENT_DESCR

Method Summary

Modifier and Type	Method and Description
java.lang.String	format(BaseDateInterval dateInterval) Formats date interval to string presentation.
java.lang.String	getLocalizedValue(BaseDateInterval dateInterval) Formats date interval and gets localized value.
boolean	matches(java.lang.String dateInterval) Checks that provided date interval matches with converter's value pattern.
BaseDateInterval	parse(java.lang.String dateInterval) Parses string presentation of date interval to BaseDateInterval.
boolean	supports(BaseDateInterval.Type type)

Field Detail

INCLUDING_CURRENT_DESCR

static final java.lang.String INCLUDING_CURRENT_DESCR

See Also:

Constant Field Values

Method Detail

parse

@Nullable
BaseDateInterval parse(java.lang.String dateInterval)

Parses string presentation of date interval to BaseDateInterval.

Parameters:

dateInterval - string presentation of date interval

Returns:

configured date interval or null if input parameter is null or empty.

format

java.lang.String format(BaseDateInterval dateInterval)

Formats date interval to string presentation.

Parameters:

dateInterval - date interval instance

Returns:

raw presentation of date interval

getLocalizedValue

@Nullable
java.lang.String getLocalizedValue(@Nullable
                                             BaseDateInterval dateInterval)

Formats date interval and gets localized value.

Parameters:

dateInterval - date interval instance

Returns:

localized value

matches

boolean matches(java.lang.String dateInterval)

Checks that provided date interval matches with converter's value pattern.

Parameters:

dateInterval - string presentation of date interval

Returns:

true if provided date interval matches with the value pattern of the converter

supports

boolean supports(BaseDateInterval.Type type)

Parameters:

type - date interval type

Returns:

true if converter supports the given type