io.jmix.core.metamodel.datatype

Class DatatypeFormatter

java.lang.Object

io.jmix.core.metamodel.datatype.DatatypeFormatter

@Component(value="core_DatatypeFormatter")
public class DatatypeFormatter
extends java.lang.Object

Convenience bean for locale-dependent conversion of some widely used data types to and from strings.

For locale-independent conversion use Datatype methods directly.

Field Summary

Fields

Modifier and Type	Field and Description
protected CurrentAuthentication	currentAuthentication
protected DatatypeRegistry	datatypeRegistry

Constructor Summary

Constructors

Constructor and Description
DatatypeFormatter()

Method Summary

Modifier and Type	Method and Description
java.lang.String	formatBigDecimal(java.math.BigDecimal value) Format BigDecimal using decimalFormat string specified in the main message group.
java.lang.String	formatBoolean(java.lang.Boolean value) Format Boolean using trueString and falseString strings specified in the main message group.
java.lang.String	formatDate(java.util.Date value) Format Date (date without time) using dateFormat string specified in the main message group.
java.lang.String	formatDateTime(java.util.Date value) Format Date (date and time) using dateTimeFormat string specified in the main message group.
java.lang.String	formatDouble(java.lang.Double value) Format Double using doubleFormat string specified in the main message group.
java.lang.String	formatInteger(java.lang.Integer value) Format Integer using integerFormat string specified in the main message group.
java.lang.String	formatLocalDate(java.time.LocalDate value) Format LocalDate (date without time and without a time-zone) using dateFormat string specified in the main message group.
java.lang.String	formatLocalDateTime(java.time.LocalDateTime value) Format LocalDateTime (date and time without a time-zone) using dateTimeFormat string specified in the main message group.
java.lang.String	formatLocalTime(java.time.LocalTime value) Format LocalTime (time without date and without a time-zone) using timeFormat string specified in the main message group.
java.lang.String	formatLong(java.lang.Long value) Format Long using integerFormat string specified in the main message group.
java.lang.String	formatOffsetDateTime(java.time.OffsetDateTime value) Format OffsetDateTime (date and time with an offset from UTC/Greenwich) using offsetDateTimeFormat string specified in the main message group.
java.lang.String	formatOffsetTime(java.time.OffsetTime value) Format OffsetTime (time with an offset from UTC/Greenwich) using offsetTimeFormat string specified in the main message group.
java.lang.String	formatTime(java.util.Date value) Format Date (time without date) using timeFormat string specified in the main message group.
java.math.BigDecimal	parseBigDecimal(java.lang.String str) Parse BigDecimal using decimalFormat string specified in the main message group.
java.lang.Boolean	parseBoolean(java.lang.String str) Parse Boolean using trueString and falseString strings specified in the main message group.
java.util.Date	parseDate(java.lang.String str) Parse Date (date without time) using dateFormat string specified in the main message group.
java.util.Date	parseDateTime(java.lang.String str) Parse Date (date and time) using dateTimeFormat string specified in the main message group.
java.lang.Double	parseDouble(java.lang.String str) Parse Double using doubleFormat string specified in the main message group.
java.lang.Integer	parseInteger(java.lang.String str) Parse Integer using integerFormat string specified in the main message group.
java.time.LocalDate	parseLocalDate(java.lang.String str) Parse LocalDate (date without time and without a time-zone) using dateFormat string specified in the main message group.
java.time.LocalDateTime	parseLocalDateTime(java.lang.String str) Parse LocalDateTime (date and time without a time-zone) using dateTimeFormat string specified in the main message group.
java.time.LocalTime	parseLocalTime(java.lang.String str) Parse LocalTime (time without date and without a time-zone) using timeFormat string specified in the main message group.
java.lang.Long	parseLong(java.lang.String str) Parse Long using integerFormat string specified in the main message group.
java.time.OffsetDateTime	parseOffsetDateTime(java.lang.String str) Parse OffsetDateTime (date and time with an offset from UTC/Greenwich) using offsetDateTimeFormat string specified in the main message group.
java.time.OffsetTime	parseOffsetTime(java.lang.String str) Parse OffsetTime (time without date and with an offset from UTC/Greenwich) using offsetTimeFormat string specified in the main message group.
java.util.Date	parseTime(java.lang.String str) Parse Date (time without date) using timeFormat string specified in the main message group.

Methods inherited from class java.lang.Object

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

Field Detail

currentAuthentication

@Autowired
protected CurrentAuthentication currentAuthentication

datatypeRegistry

@Autowired
protected DatatypeRegistry datatypeRegistry

Constructor Detail

DatatypeFormatter

public DatatypeFormatter()

Method Detail

formatDate

public java.lang.String formatDate(@Nullable
                                   java.util.Date value)

Format Date (date without time) using dateFormat string specified in the main message group.

Returns:

string representation or empty string if the value is null

formatTime

public java.lang.String formatTime(@Nullable
                                   java.util.Date value)

Format Date (time without date) using timeFormat string specified in the main message group.

Returns:

string representation or empty string if the value is null

formatDateTime

public java.lang.String formatDateTime(@Nullable
                                       java.util.Date value)

Format Date (date and time) using dateTimeFormat string specified in the main message group.

Takes into account time zone if it is set for the current user session.

Returns:

string representation or empty string if the value is null

formatLocalDate

public java.lang.String formatLocalDate(@Nullable
                                        java.time.LocalDate value)

Format LocalDate (date without time and without a time-zone) using dateFormat string specified in the main message group.

Returns:

string representation or empty string if the value is null

formatLocalDateTime

public java.lang.String formatLocalDateTime(@Nullable
                                            java.time.LocalDateTime value)

Format LocalDateTime (date and time without a time-zone) using dateTimeFormat string specified in the main message group.

Returns:

string representation or empty string if the value is null

formatLocalTime

public java.lang.String formatLocalTime(@Nullable
                                        java.time.LocalTime value)

Format LocalTime (time without date and without a time-zone) using timeFormat string specified in the main message group.

Returns:

string representation or empty string if the value is null

formatOffsetDateTime

public java.lang.String formatOffsetDateTime(@Nullable
                                             java.time.OffsetDateTime value)

Format OffsetDateTime (date and time with an offset from UTC/Greenwich) using offsetDateTimeFormat string specified in the main message group.

Returns:

string representation or empty string if the value is null

formatOffsetTime

public java.lang.String formatOffsetTime(@Nullable
                                         java.time.OffsetTime value)

Format OffsetTime (time with an offset from UTC/Greenwich) using offsetTimeFormat string specified in the main message group.

Returns:

string representation or empty string if the value is null

formatDouble

public java.lang.String formatDouble(@Nullable
                                     java.lang.Double value)

Format Double using doubleFormat string specified in the main message group.

Returns:

string representation or empty string if the value is null

formatBigDecimal

public java.lang.String formatBigDecimal(@Nullable
                                         java.math.BigDecimal value)

Format BigDecimal using decimalFormat string specified in the main message group.

Returns:

string representation or empty string if the value is null

formatBoolean

public java.lang.String formatBoolean(@Nullable
                                      java.lang.Boolean value)

Format Boolean using trueString and falseString strings specified in the main message group.

Returns:

string representation or empty string if the value is null

formatInteger

public java.lang.String formatInteger(@Nullable
                                      java.lang.Integer value)

Format Integer using integerFormat string specified in the main message group.

Returns:

string representation or empty string if the value is null

formatLong

public java.lang.String formatLong(@Nullable
                                   java.lang.Long value)

Format Long using integerFormat string specified in the main message group.

Returns:

string representation or empty string if the value is null

parseDate

@Nullable
public java.util.Date parseDate(java.lang.String str)
                                   throws java.text.ParseException

Parse Date (date without time) using dateFormat string specified in the main message group.

Returns:

Date value or null if a blank string is provided

Throws:

java.text.ParseException

parseTime

@Nullable
public java.util.Date parseTime(java.lang.String str)
                                   throws java.text.ParseException

Parse Date (time without date) using timeFormat string specified in the main message group.

Returns:

Date value or null if a blank string is provided

Throws:

java.text.ParseException

parseDateTime

@Nullable
public java.util.Date parseDateTime(java.lang.String str)
                                       throws java.text.ParseException

Parse Date (date and time) using dateTimeFormat string specified in the main message group.

Takes into account time zone if it is set for the current user session.

Returns:

Date value or null if a blank string is provided

Throws:

java.text.ParseException

parseLocalDate

@Nullable
public java.time.LocalDate parseLocalDate(java.lang.String str)
                                             throws java.text.ParseException

Parse LocalDate (date without time and without a time-zone) using dateFormat string specified in the main message group.

Returns:

LocalDate value or null if a blank string is provided

Throws:

java.text.ParseException

parseLocalTime

@Nullable
public java.time.LocalTime parseLocalTime(java.lang.String str)
                                             throws java.text.ParseException

Parse LocalTime (time without date and without a time-zone) using timeFormat string specified in the main message group.

Returns:

LocalTime value or null if a blank string is provided

Throws:

java.text.ParseException

parseLocalDateTime

@Nullable
public java.time.LocalDateTime parseLocalDateTime(java.lang.String str)
                                                     throws java.text.ParseException

Parse LocalDateTime (date and time without a time-zone) using dateTimeFormat string specified in the main message group.

Returns:

LocalDateTime value or null if a blank string is provided

Throws:

java.text.ParseException

parseOffsetDateTime

@Nullable
public java.time.OffsetDateTime parseOffsetDateTime(java.lang.String str)
                                                       throws java.text.ParseException

Parse OffsetDateTime (date and time with an offset from UTC/Greenwich) using offsetDateTimeFormat string specified in the main message group.

Returns:

OffsetDateTime value or null if a blank string is provided

Throws:

java.text.ParseException

parseOffsetTime

@Nullable
public java.time.OffsetTime parseOffsetTime(java.lang.String str)
                                               throws java.text.ParseException

Parse OffsetTime (time without date and with an offset from UTC/Greenwich) using offsetTimeFormat string specified in the main message group.

Returns:

OffsetTime value or null if a blank string is provided

Throws:

java.text.ParseException

parseDouble

@Nullable
public java.lang.Double parseDouble(java.lang.String str)
                                       throws java.text.ParseException

Parse Double using doubleFormat string specified in the main message group.

Returns:

Double value or null if a blank string is provided

Throws:

java.text.ParseException

parseBigDecimal

@Nullable
public java.math.BigDecimal parseBigDecimal(java.lang.String str)
                                               throws java.text.ParseException

Parse BigDecimal using decimalFormat string specified in the main message group.

Returns:

BigDecimal value or null if a blank string is provided

Throws:

java.text.ParseException

parseBoolean

@Nullable
public java.lang.Boolean parseBoolean(java.lang.String str)
                                         throws java.text.ParseException

Parse Boolean using trueString and falseString strings specified in the main message group.

Returns:

Boolean value or null if a blank string is provided

Throws:

java.text.ParseException

parseInteger

@Nullable
public java.lang.Integer parseInteger(java.lang.String str)
                                         throws java.text.ParseException

Parse Integer using integerFormat string specified in the main message group.

Returns:

Integer value or null if a blank string is provided

Throws:

java.text.ParseException

parseLong

@Nullable
public java.lang.Long parseLong(java.lang.String str)
                                   throws java.text.ParseException

Parse Long using integerFormat string specified in the main message group.

Returns:

Long value or null if a blank string is provided

Throws:

java.text.ParseException