123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157 |
- /*
- * Copyright 2000-2018 Vaadin Ltd.
- *
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License. You may obtain a copy of
- * the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- * License for the specific language governing permissions and limitations under
- * the 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<Component> 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<Locale> 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<HasValue<?>> getHasValue() {
- return Optional.ofNullable(hasValue);
- }
- }
|