com.vaadin.data.ValueContext 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.data;
import java.io.Serializable;
import java.util.Locale;
import java.util.Optional;
import com.vaadin.ui.Component;
import com.vaadin.ui.UI;
/**
* Value context for {@code Converter}s. Contains relevant information for
* converting values.
*
* @author Vaadin Ltd.
* @since 8.0
*/
public class ValueContext implements Serializable {
private final Component component;
private final HasValue hasValue;
private final Locale locale;
/**
* Constructor for {@code ValueContext} without a {@code Locale}.
*/
public ValueContext() {
component = null;
hasValue = null;
locale = findLocale();
}
/**
* Constructor for {@code ValueContext} without a {@code Component}.
*
* @param locale
* The locale used with conversion. Can be null.
*/
public ValueContext(Locale locale) {
component = null;
this.locale = locale;
hasValue = null;
}
/**
* Constructor for {@code ValueContext}.
*
* @param component
* The component related to current value. Can be null. If the
* component implements {@link HasValue}, it will be returned by
* {@link #getHasValue()} as well.
*/
@SuppressWarnings("unchecked")
public ValueContext(Component component) {
this.component = component;
if (component instanceof HasValue) {
hasValue = (HasValue) component;
} else {
hasValue = null;
}
locale = findLocale();
}
/**
* Constructor for {@code ValueContext}.
*
* @param component
* The component related to current value. Can be null.
* @param hasValue
* The value source related to current value. Can be null.
* @since 8.1
*/
public ValueContext(Component component, HasValue hasValue) {
this.component = component;
this.hasValue = hasValue;
locale = findLocale();
}
/**
* Constructor for {@code ValueContext}.
*
* @param component
* The component can be {@code null}.
* @param locale
* The locale used with conversion. Can be {@code null}.
* @param hasValue
* The value source related to current value. Can be
* {@code null}.
* @since 8.1
*/
public ValueContext(Component component, HasValue hasValue,
Locale locale) {
this.component = component;
this.hasValue = hasValue;
this.locale = locale;
}
private Locale findLocale() {
Locale l = null;
if (component != null) {
l = component.getLocale();
}
if (l == null && UI.getCurrent() != null) {
l = UI.getCurrent().getLocale();
}
if (l == null) {
l = Locale.getDefault();
}
return l;
}
/**
* Returns an {@code Optional} for the {@code Component} related to value
* conversion.
*
* @return the optional of component
*/
public Optional getComponent() {
return Optional.ofNullable(component);
}
/**
* Returns an {@code Optional} for the {@code Locale} used in the value
* conversion.
*
* @return the optional of locale
*/
public Optional getLocale() {
return Optional.ofNullable(locale);
}
/**
* Returns an {@code Optional} for the {@code HasValue} used in the value
* conversion. In certain complicated cases, ex. cross-field validation,
* HasValue might be not available.
*
* @return the optional of {@code HasValue}
* @since 8.1
*/
public Optional> getHasValue() {
return Optional.ofNullable(hasValue);
}
}