com.vaadin.ui.renderers.LocalDateTimeRenderer Maven / Gradle / Ivy
/*
* Copyright (C) 2000-2024 Vaadin Ltd
*
* This program is available under Vaadin Commercial License and Service Terms.
*
* See for the full
* license.
*/
package com.vaadin.ui.renderers;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
import java.time.format.FormatStyle;
import java.util.Locale;
import com.vaadin.server.SerializableSupplier;
import com.vaadin.shared.ui.grid.renderers.LocalDateTimeRendererState;
import elemental.json.JsonValue;
import static com.vaadin.data.util.BeanUtil.checkSerialization;
/**
* A renderer for presenting {@code LocalDateTime} objects.
*
* @author Vaadin Ltd
* @since 8.1
*/
public class LocalDateTimeRenderer
extends AbstractRenderer {
private SerializableSupplier formatterSupplier;
private boolean getLocaleFromGrid;
/**
* Creates a new LocalDateTimeRenderer.
*
* The renderer is configured to render with the grid's locale it is
* attached to, with the format style being {@code FormatStyle.LONG} for the
* date and {@code FormatStyle.SHORT} for time, with an empty string as its
* null representation.
*
* @see
* FormatStyle.LONG
* @see
* FormatStyle.SHORT
*/
public LocalDateTimeRenderer() {
this(() -> DateTimeFormatter.ofLocalizedDateTime(FormatStyle.LONG,
FormatStyle.SHORT), "");
getLocaleFromGrid = true;
}
/**
* Creates a new LocalDateTimeRenderer.
*
* The renderer is configured to render with the given formatter, with the
* empty string as its null representation.
*
*
* Note the {@code DateTimeFormatter} is not a serializable class, so
* using this method in an environment which requires session persistence
* may produce {@link java.io.NotSerializableException}.
*
* @param formatter
* the formatter to use, not {@code null}
*
* @throws IllegalArgumentException
* if formatter is null
* @deprecated the method is unsafe for serialization, may produce troubles
* in a cluster environment
* @see #LocalDateTimeRenderer(SerializableSupplier)
*/
@Deprecated
public LocalDateTimeRenderer(DateTimeFormatter formatter) {
this(formatter, "");
}
/**
* Creates a new LocalDateTimeRenderer.
*
* The renderer is configured to render with the given formatter.
*
*
* Note the {@code DateTimeFormatter} is not a serializable class, so
* using this method in an environment which requires session persistence
* may produce {@link java.io.NotSerializableException}.
*
*
* @param formatter
* the formatter to use, not {@code null}
* @param nullRepresentation
* the textual representation of the {@code null} value
*
* @throws IllegalArgumentException
* if formatter is null
* @deprecated the method is unsafe for serialization, may produce troubles
* in acluster environment
* @see #LocalDateTimeRenderer(SerializableSupplier, String)
*/
@Deprecated
public LocalDateTimeRenderer(DateTimeFormatter formatter,
String nullRepresentation) {
super(LocalDateTime.class, nullRepresentation);
if (formatter == null) {
throw new IllegalArgumentException("formatter may not be null");
}
this.formatterSupplier = () -> formatter;
}
/**
* Creates a new LocalDateTimeRenderer.
*
* The renderer is configured to render with the given string format, as
* displayed in the grid's locale it is attached to, with an empty string as
* its null representation.
*
* @param formatPattern
* the format pattern to format the date with, not {@code null}
*
* @throws IllegalArgumentException
* if format pattern is null
*
* @see
* Format Pattern Syntax
*/
public LocalDateTimeRenderer(String formatPattern) {
this(formatPattern, Locale.getDefault());
getLocaleFromGrid = true;
}
/**
* Creates a new LocalDateTimeRenderer.
*
* The renderer is configured to render with the given string format, as
* displayed in the given locale, with an empty string as its null
* representation.
*
* @param formatPattern
* the format pattern to format the date with, not {@code null}
* @param locale
* the locale to use, not {@code null}
*
* @throws IllegalArgumentException
* if format pattern is null
* @throws IllegalArgumentException
* if locale is null
*
* @see
* Format Pattern Syntax
*/
public LocalDateTimeRenderer(String formatPattern, Locale locale) {
this(formatPattern, locale, "");
}
/**
* Creates a new LocalDateTimeRenderer.
*
* The renderer is configured to render with the given string format, as
* displayed in the given locale.
*
* @param formatPattern
* the format pattern to format the date with, not {@code null}
* @param locale
* the locale to use, not {@code null}
* @param nullRepresentation
* the textual representation of the {@code null} value
*
* @throws IllegalArgumentException
* if format pattern is null
* @throws IllegalArgumentException
* if locale is null
*
* @see
* Format Pattern Syntax
*/
public LocalDateTimeRenderer(String formatPattern, Locale locale,
String nullRepresentation) {
super(LocalDateTime.class, nullRepresentation);
if (formatPattern == null) {
throw new IllegalArgumentException(
"format pattern may not be null");
}
if (locale == null) {
throw new IllegalArgumentException("locale may not be null");
}
formatterSupplier = () -> DateTimeFormatter.ofPattern(formatPattern,
locale);
}
/**
* Creates a new LocalDateTimeRenderer.
*
* The renderer is configured to render with the given formatterSupplier.
*
* @param formatterSupplier
* the formatterSupplier supplier to use, not {@code null}, it
* should not supply {@code null} either
* @throws IllegalArgumentException
* if formatterSupplier is null
*/
public LocalDateTimeRenderer(
SerializableSupplier formatterSupplier) {
this(formatterSupplier, "");
}
/**
* Creates a new LocalDateTimeRenderer.
*
* The renderer is configured to render with the given formatterSupplier.
*
* @param formatterSupplier
* the formatterSupplier supplier to use, not {@code null}, it
* should not supply {@code null} either
* @param nullRepresentation
* the textual representation of the {@code null} value
*
* @throws IllegalArgumentException
* if formatterSupplier is null
*/
public LocalDateTimeRenderer(
SerializableSupplier formatterSupplier,
String nullRepresentation) {
super(LocalDateTime.class, nullRepresentation);
if (formatterSupplier == null) {
throw new IllegalArgumentException(
"formatterSupplier may not be null");
}
this.formatterSupplier = formatterSupplier;
assert checkSerialization(formatterSupplier);
}
@Override
public JsonValue encode(LocalDateTime value) {
String dateString;
if (value == null) {
dateString = getNullRepresentation();
} else if (getLocaleFromGrid) {
if (getParentGrid() == null) {
throw new IllegalStateException(
"Could not find a locale to format with: "
+ "this renderer should either be attached to a grid "
+ "or constructed with locale information");
}
dateString = value.format(formatterSupplier.get()
.withLocale(getParentGrid().getLocale()));
} else {
dateString = value.format(formatterSupplier.get());
}
return encode(dateString, String.class);
}
@Override
protected LocalDateTimeRendererState getState() {
return (LocalDateTimeRendererState) super.getState();
}
@Override
protected LocalDateTimeRendererState getState(boolean markAsDirty) {
return (LocalDateTimeRendererState) super.getState(markAsDirty);
}
}