123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620 |
- /*
- * Copyright 2000-2016 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.ArrayList;
- import java.util.Arrays;
- import java.util.Collections;
- import java.util.HashMap;
- import java.util.IdentityHashMap;
- import java.util.LinkedHashSet;
- import java.util.List;
- import java.util.Locale;
- import java.util.Map;
- import java.util.Objects;
- import java.util.Optional;
- import java.util.Set;
- import java.util.stream.Collectors;
-
- import com.vaadin.data.HasValue.ValueChangeEvent;
- import com.vaadin.data.util.converter.Converter;
- import com.vaadin.data.util.converter.StringToIntegerConverter;
- import com.vaadin.data.util.converter.ValueContext;
- import com.vaadin.event.EventRouter;
- import com.vaadin.server.ErrorMessage;
- import com.vaadin.server.SerializableBiConsumer;
- import com.vaadin.server.SerializableFunction;
- import com.vaadin.server.SerializablePredicate;
- import com.vaadin.server.UserError;
- import com.vaadin.shared.Registration;
- import com.vaadin.ui.AbstractComponent;
- import com.vaadin.ui.AbstractMultiSelect;
- import com.vaadin.ui.Component;
- import com.vaadin.ui.Label;
- import com.vaadin.ui.UI;
-
- /**
- * Connects one or more {@code Field} components to properties of a backing data
- * type such as a bean type. With a binder, input components can be grouped
- * together into forms to easily create and update business objects with little
- * explicit logic needed to move data between the UI and the data layers of the
- * application.
- * <p>
- * A binder is a collection of <i>bindings</i>, each representing the mapping of
- * a single field, through converters and validators, to a backing property.
- * <p>
- * A binder instance can be bound to a single bean instance at a time, but can
- * be rebound as needed. This allows usage patterns like a <i>master-details</i>
- * view, where a select component is used to pick the bean to edit.
- * <p>
- * Bean level validators can be added using the
- * {@link #withValidator(Validator)} method and will be run on the bound bean
- * once it has been updated from the values of the bound fields. Bean level
- * validators are also run as part of {@link #writeBean(Object)} and
- * {@link #writeBeanIfValid(Object)} if all field level validators pass.
- * <p>
- * Note: For bean level validators, the bean must be updated before the
- * validators are run. If a bean level validator fails in
- * {@link #writeBean(Object)} or {@link #writeBeanIfValid(Object)}, the bean
- * will be reverted to the previous state before returning from the method. You
- * should ensure that the getters/setters in the bean do not have side effects.
- * <p>
- * Unless otherwise specified, {@code Binder} method arguments cannot be null.
- *
- * @author Vaadin Ltd.
- *
- * @param <BEAN>
- * the bean type
- *
- * @see Binding
- * @see HasValue
- *
- * @since 8.0
- */
- public class Binder<BEAN> implements Serializable {
-
- /**
- * Represents the binding between a field and a data property.
- *
- * @param <BEAN>
- * the bean type
- * @param <TARGET>
- * the target data type of the binding, matches the field type
- * until a converter has been set
- *
- * @see Binder#forField(HasValue)
- */
- public interface Binding<BEAN, TARGET> extends Serializable {
-
- /**
- * Completes this binding using the given getter and setter functions
- * representing a backing bean property. The functions are used to
- * update the field value from the property and to store the field value
- * to the property, respectively.
- * <p>
- * When a bean is bound with {@link Binder#setBean(BEAN)}, the field
- * value is set to the return value of the given getter. The property
- * value is then updated via the given setter whenever the field value
- * changes. The setter may be null; in that case the property value is
- * never updated and the binding is said to be <i>read-only</i>.
- * <p>
- * If the Binder is already bound to some bean, the newly bound field is
- * associated with the corresponding bean property as described above.
- * <p>
- * The getter and setter can be arbitrary functions, for instance
- * implementing user-defined conversion or validation. However, in the
- * most basic use case you can simply pass a pair of method references
- * to this method as follows:
- *
- * <pre>
- * class Person {
- * public String getName() { ... }
- * public void setName(String name) { ... }
- * }
- *
- * TextField nameField = new TextField();
- * binder.forField(nameField).bind(Person::getName, Person::setName);
- * </pre>
- *
- * @param getter
- * the function to get the value of the property to the
- * field, not null
- * @param setter
- * the function to write the field value to the property or
- * null if read-only
- * @throws IllegalStateException
- * if {@code bind} has already been called on this binding
- */
- public void bind(SerializableFunction<BEAN, TARGET> getter,
- com.vaadin.server.SerializableBiConsumer<BEAN, TARGET> setter);
-
- /**
- * Adds a validator to this binding. Validators are applied, in
- * registration order, when the field value is written to the backing
- * property. If any validator returns a failure, the property value is
- * not updated.
- *
- * @see #withValidator(SerializablePredicate, String)
- * @see #withValidator(SerializablePredicate, ErrorMessageProvider)
- *
- * @param validator
- * the validator to add, not null
- * @return this binding, for chaining
- * @throws IllegalStateException
- * if {@code bind} has already been called
- */
- public Binding<BEAN, TARGET> withValidator(
- Validator<? super TARGET> validator);
-
- /**
- * A convenience method to add a validator to this binding using the
- * {@link Validator#from(SerializablePredicate, String)} factory method.
- * <p>
- * Validators are applied, in registration order, when the field value
- * is written to the backing property. If any validator returns a
- * failure, the property value is not updated.
- *
- * @see #withValidator(Validator)
- * @see #withValidator(SerializablePredicate, ErrorMessageProvider)
- * @see Validator#from(SerializablePredicate, String)
- *
- * @param predicate
- * the predicate performing validation, not null
- * @param message
- * the error message to report in case validation failure
- * @return this binding, for chaining
- * @throws IllegalStateException
- * if {@code bind} has already been called
- */
- public default Binding<BEAN, TARGET> withValidator(
- SerializablePredicate<? super TARGET> predicate,
- String message) {
- return withValidator(Validator.from(predicate, message));
- }
-
- /**
- * A convenience method to add a validator to this binding using the
- * {@link Validator#from(SerializablePredicate, ErrorMessageProvider)}
- * factory method.
- * <p>
- * Validators are applied, in registration order, when the field value
- * is written to the backing property. If any validator returns a
- * failure, the property value is not updated.
- *
- * @see #withValidator(Validator)
- * @see #withValidator(SerializablePredicate, String)
- * @see Validator#from(SerializablePredicate, ErrorMessageProvider)
- *
- * @param predicate
- * the predicate performing validation, not null
- * @param errorMessageProvider
- * the provider to generate error messages, not null
- * @return this binding, for chaining
- * @throws IllegalStateException
- * if {@code bind} has already been called
- */
- public default Binding<BEAN, TARGET> withValidator(
- SerializablePredicate<? super TARGET> predicate,
- ErrorMessageProvider errorMessageProvider) {
- return withValidator(
- Validator.from(predicate, errorMessageProvider));
- }
-
- /**
- * Maps the binding to another data type using the given
- * {@link Converter}.
- * <p>
- * A converter is capable of converting between a presentation type,
- * which must match the current target data type of the binding, and a
- * model type, which can be any data type and becomes the new target
- * type of the binding. When invoking
- * {@link #bind(SerializableFunction, SerializableBiConsumer)}, the
- * target type of the binding must match the getter/setter types.
- * <p>
- * For instance, a {@code TextField} can be bound to an integer-typed
- * property using an appropriate converter such as a
- * {@link StringToIntegerConverter}.
- *
- * @param <NEWTARGET>
- * the type to convert to
- * @param converter
- * the converter to use, not null
- * @return a new binding with the appropriate type
- * @throws IllegalStateException
- * if {@code bind} has already been called
- */
- public <NEWTARGET> Binding<BEAN, NEWTARGET> withConverter(
- Converter<TARGET, NEWTARGET> converter);
-
- /**
- * Maps the binding to another data type using the mapping functions and
- * a possible exception as the error message.
- * <p>
- * The mapping functions are used to convert between a presentation
- * type, which must match the current target data type of the binding,
- * and a model type, which can be any data type and becomes the new
- * target type of the binding. When invoking
- * {@link #bind(SerializableFunction, SerializableBiConsumer)}, the
- * target type of the binding must match the getter/setter types.
- * <p>
- * For instance, a {@code TextField} can be bound to an integer-typed
- * property using appropriate functions such as:
- * <code>withConverter(Integer::valueOf, String::valueOf);</code>
- *
- * @param <NEWTARGET>
- * the type to convert to
- * @param toModel
- * the function which can convert from the old target type to
- * the new target type
- * @param toPresentation
- * the function which can convert from the new target type to
- * the old target type
- * @return a new binding with the appropriate type
- * @throws IllegalStateException
- * if {@code bind} has already been called
- */
- public default <NEWTARGET> Binding<BEAN, NEWTARGET> withConverter(
- SerializableFunction<TARGET, NEWTARGET> toModel,
- SerializableFunction<NEWTARGET, TARGET> toPresentation) {
- return withConverter(Converter.from(toModel, toPresentation,
- exception -> exception.getMessage()));
- }
-
- /**
- * Maps the binding to another data type using the mapping functions and
- * the given error error message if a value cannot be converted to the
- * new target type.
- * <p>
- * The mapping functions are used to convert between a presentation
- * type, which must match the current target data type of the binding,
- * and a model type, which can be any data type and becomes the new
- * target type of the binding. When invoking
- * {@link #bind(SerializableFunction, SerializableBiConsumer)}, the
- * target type of the binding must match the getter/setter types.
- * <p>
- * For instance, a {@code TextField} can be bound to an integer-typed
- * property using appropriate functions such as:
- * <code>withConverter(Integer::valueOf, String::valueOf);</code>
- *
- * @param <NEWTARGET>
- * the type to convert to
- * @param toModel
- * the function which can convert from the old target type to
- * the new target type
- * @param toPresentation
- * the function which can convert from the new target type to
- * the old target type
- * @param errorMessage
- * the error message to use if conversion using
- * <code>toModel</code> fails
- * @return a new binding with the appropriate type
- * @throws IllegalStateException
- * if {@code bind} has already been called
- */
- public default <NEWTARGET> Binding<BEAN, NEWTARGET> withConverter(
- SerializableFunction<TARGET, NEWTARGET> toModel,
- SerializableFunction<NEWTARGET, TARGET> toPresentation,
- String errorMessage) {
- return withConverter(Converter.from(toModel, toPresentation,
- exception -> errorMessage));
- }
-
- /**
- * Maps binding value {@code null} to given null representation and back
- * to {@code null} when converting back to model value.
- *
- * @param nullRepresentation
- * the value to use instead of {@code null}
- * @return a new binding with null representation handling.
- */
- public default Binding<BEAN, TARGET> withNullRepresentation(
- TARGET nullRepresentation) {
- return withConverter(
- fieldValue -> Objects.equals(fieldValue, nullRepresentation)
- ? null : fieldValue,
- modelValue -> Objects.isNull(modelValue)
- ? nullRepresentation : modelValue);
- }
-
- /**
- * Gets the field the binding uses.
- *
- * @return the field for the binding
- */
- public HasValue<?> getField();
-
- /**
- * Sets the given {@code label} to show an error message if validation
- * fails.
- * <p>
- * The validation state of each field is updated whenever the user
- * modifies the value of that field. The validation state is by default
- * shown using {@link AbstractComponent#setComponentError} which is used
- * by the layout that the field is shown in. Most built-in layouts will
- * show this as a red exclamation mark icon next to the component, so
- * that hovering or tapping the icon shows a tooltip with the message
- * text.
- * <p>
- * This method allows to customize the way a binder displays error
- * messages to get more flexibility than what
- * {@link AbstractComponent#setComponentError} provides (it replaces the
- * default behavior).
- * <p>
- * This is just a shorthand for
- * {@link #withValidationStatusHandler(ValidationStatusHandler)} method
- * where the handler instance hides the {@code label} if there is no
- * error and shows it with validation error message if validation fails.
- * It means that it cannot be called after
- * {@link #withValidationStatusHandler(ValidationStatusHandler)} method
- * call or {@link #withValidationStatusHandler(ValidationStatusHandler)}
- * after this method call.
- *
- * @see #withValidationStatusHandler(ValidationStatusHandler)
- * @see AbstractComponent#setComponentError(ErrorMessage)
- * @param label
- * label to show validation status for the field
- * @return this binding, for chaining
- */
- public default Binding<BEAN, TARGET> withStatusLabel(Label label) {
- return withValidationStatusHandler(status -> {
- label.setValue(status.getMessage().orElse(""));
- // Only show the label when validation has failed
- label.setVisible(status.isError());
- });
- }
-
- /**
- * Sets a {@link ValidationStatusHandler} to track validation status
- * changes.
- * <p>
- * The validation state of each field is updated whenever the user
- * modifies the value of that field. The validation state is by default
- * shown using {@link AbstractComponent#setComponentError} which is used
- * by the layout that the field is shown in. Most built-in layouts will
- * show this as a red exclamation mark icon next to the component, so
- * that hovering or tapping the icon shows a tooltip with the message
- * text.
- * <p>
- * This method allows to customize the way a binder displays error
- * messages to get more flexibility than what
- * {@link AbstractComponent#setComponentError} provides (it replaces the
- * default behavior).
- * <p>
- * The method may be called only once. It means there is no chain unlike
- * {@link #withValidator(Validator)} or
- * {@link #withConverter(Converter)}. Also it means that the shorthand
- * method {@link #withStatusLabel(Label)} also may not be called after
- * this method.
- *
- * @see #withStatusLabel(Label)
- * @see AbstractComponent#setComponentError(ErrorMessage)
- * @param handler
- * status change handler
- * @return this binding, for chaining
- */
- public Binding<BEAN, TARGET> withValidationStatusHandler(
- ValidationStatusHandler handler);
-
- /**
- * Validates the field value and returns a {@code ValidationStatus}
- * instance representing the outcome of the validation.
- *
- * @see Binder#validate()
- * @see Validator#apply(Object)
- *
- * @return the validation result.
- */
- public ValidationStatus<TARGET> validate();
-
- /**
- * Sets the field to be required. This means two things:
- * <ol>
- * <li>the required indicator is visible</li>
- * <li>the field value is validated for not being empty*</li>
- * </ol>
- * For localizing the error message, use
- * {@link #setRequired(SerializableFunction)}.
- * <p>
- * *Value not being the equal to what {@link HasValue#getEmptyValue()}
- * returns.
- *
- * @see #setRequired(SerializableFunction)
- * @see HasValue#setRequiredIndicatorVisible(boolean)
- * @see HasValue#isEmpty()
- * @param errorMessage
- * the error message to show for the invalid value
- * @return this binding, for chaining
- */
- public default Binding<BEAN, TARGET> setRequired(String errorMessage) {
- return setRequired(context -> errorMessage);
- }
-
- /**
- * Sets the field to be required. This means two things:
- * <ol>
- * <li>the required indicator is visible</li>
- * <li>the field value is validated for not being empty*</li>
- * </ol>
- * *Value not being the equal to what {@link HasValue#getEmptyValue()}
- * returns.
- *
- * @see HasValue#setRequiredIndicatorVisible(boolean)
- * @see HasValue#isEmpty()
- * @param errorMessageProvider
- * the provider for localized validation error message
- * @return this binding, for chaining
- */
- public Binding<BEAN, TARGET> setRequired(
- ErrorMessageProvider errorMessageProvider);
- }
-
- /**
- * An internal implementation of {@code Binding}.
- *
- * @param <BEAN>
- * the bean type, must match the Binder bean type
- * @param <FIELDVALUE>
- * the value type of the field
- * @param <TARGET>
- * the target data type of the binding, matches the field type
- * until a converter has been set
- */
- protected static class BindingImpl<BEAN, FIELDVALUE, TARGET>
- implements Binding<BEAN, TARGET> {
-
- private final Binder<BEAN> binder;
-
- private final HasValue<FIELDVALUE> field;
- private Registration onValueChange;
- private ValidationStatusHandler statusHandler;
- private boolean isStatusHandlerChanged;
-
- private SerializableFunction<BEAN, TARGET> getter;
- private SerializableBiConsumer<BEAN, TARGET> setter;
-
- /**
- * Contains all converters and validators chained together in the
- * correct order.
- */
- private Converter<FIELDVALUE, TARGET> converterValidatorChain;
-
- /**
- * Creates a new binding associated with the given field. Initializes
- * the binding with the given converter chain and status change handler.
- *
- * @param binder
- * the binder this instance is connected to, not null
- * @param field
- * the field to bind, not null
- * @param converterValidatorChain
- * the converter/validator chain to use, not null
- * @param statusHandler
- * the handler to track validation status, not null
- */
- protected BindingImpl(Binder<BEAN> binder, HasValue<FIELDVALUE> field,
- Converter<FIELDVALUE, TARGET> converterValidatorChain,
- ValidationStatusHandler statusHandler) {
- this.field = field;
- this.binder = binder;
- this.converterValidatorChain = converterValidatorChain;
- this.statusHandler = statusHandler;
- }
-
- @Override
- public void bind(SerializableFunction<BEAN, TARGET> getter,
- SerializableBiConsumer<BEAN, TARGET> setter) {
- checkUnbound();
- Objects.requireNonNull(getter, "getter cannot be null");
-
- this.getter = getter;
- this.setter = setter;
- onValueChange = getField()
- .addValueChangeListener(this::handleFieldValueChange);
- getBinder().bindings.add(this);
- getBinder().getBean().ifPresent(this::initFieldValue);
- getBinder().fireStatusChangeEvent(false);
- }
-
- @Override
- public Binding<BEAN, TARGET> withValidator(
- Validator<? super TARGET> validator) {
- checkUnbound();
- Objects.requireNonNull(validator, "validator cannot be null");
-
- converterValidatorChain = converterValidatorChain
- .chain(new ValidatorAsConverter<>(validator));
- return this;
- }
-
- @Override
- public <NEWTARGET> Binding<BEAN, NEWTARGET> withConverter(
- Converter<TARGET, NEWTARGET> converter) {
- return withConverter(converter, true);
- }
-
- @Override
- public Binding<BEAN, TARGET> withValidationStatusHandler(
- ValidationStatusHandler handler) {
- checkUnbound();
- Objects.requireNonNull(handler, "handler cannot be null");
- if (isStatusHandlerChanged) {
- throw new IllegalStateException(
- "A " + ValidationStatusHandler.class.getSimpleName()
- + " has already been set");
- }
- isStatusHandlerChanged = true;
- statusHandler = handler;
- return this;
- }
-
- @Override
- public Binding<BEAN, TARGET> setRequired(
- ErrorMessageProvider errorMessageProvider) {
- checkUnbound();
-
- getField().setRequiredIndicatorVisible(true);
- return withValidator(
- value -> !Objects.equals(value, getField().getEmptyValue()),
- errorMessageProvider);
- }
-
- @Override
- public HasValue<FIELDVALUE> getField() {
- return field;
- }
-
- /**
- * Implements {@link #withConverter(Converter)} method with additional
- * possibility to disable (reset) default null representation converter.
- * <p>
- * The method {@link #withConverter(Converter)} calls this method with
- * {@code true} provided as the second argument value.
- *
- * @see #withConverter(Converter)
- *
- * @param converter
- * the converter to use, not null
- * @param resetNullRepresentation
- * if {@code true} then default null representation will be
- * deactivated (if not yet), otherwise it won't be removed
- * @return a new binding with the appropriate type
- * @param <NEWTARGET>
- * the type to convert to
- * @throws IllegalStateException
- * if {@code bind} has already been called
- */
- protected <NEWTARGET> Binding<BEAN, NEWTARGET> withConverter(
- Converter<TARGET, NEWTARGET> converter,
- boolean resetNullRepresentation) {
- checkUnbound();
- Objects.requireNonNull(converter, "converter cannot be null");
-
- if (resetNullRepresentation) {
- getBinder().initialConverters.get(getField()).setIdentity();
- }
-
- return getBinder().createBinding(getField(),
- converterValidatorChain.chain(converter), statusHandler);
- }
-
- /**
- * Returns the {@code Binder} connected to this {@code Binding}
- * instance.
- *
- * @return the binder
- */
- protected Binder<BEAN> getBinder() {
- return binder;
- }
-
- /**
- * Throws if this binding is already completed and cannot be modified
- * anymore.
- *
- * @throws IllegalStateException
- * if this binding is already bound
- */
- protected void checkUnbound() {
- if (getter != null) {
- throw new IllegalStateException(
- "cannot modify binding: already bound to a property");
- }
- }
-
- /**
- * Finds an appropriate locale to be used in conversion and validation.
- *
- * @return the found locale, not null
- */
- protected Locale findLocale() {
- Locale l = null;
- if (getField() instanceof Component) {
- l = ((Component) getField()).getLocale();
- }
- if (l == null && UI.getCurrent() != null) {
- l = UI.getCurrent().getLocale();
- }
- if (l == null) {
- l = Locale.getDefault();
- }
- return l;
- }
-
- @Override
- public ValidationStatus<TARGET> validate() {
- ValidationStatus<TARGET> status = doValidation();
- getBinder().getValidationStatusHandler()
- .accept(new BinderValidationStatus<>(getBinder(),
- Arrays.asList(status), Collections.emptyList()));
- getBinder().fireStatusChangeEvent(status.isError());
- return status;
- }
-
- /**
- * Returns the field value run through all converters and validators,
- * but doesn't pass the {@link ValidationStatus} to any status handler.
- *
- * @return the result of the conversion
- */
- private Result<TARGET> doConversion() {
- FIELDVALUE fieldValue = field.getValue();
- return converterValidatorChain.convertToModel(fieldValue,
- createValueContext());
- }
-
- private ValidationStatus<TARGET> toValidationStatus(
- Result<TARGET> result) {
- return new ValidationStatus<>(this,
- result.isError()
- ? ValidationResult.error(result.getMessage().get())
- : ValidationResult.ok());
- }
-
- /**
- * Returns the field value run through all converters and validators,
- * but doesn't pass the {@link ValidationStatus} to any status handler.
- *
- * @return the validation status
- */
- private ValidationStatus<TARGET> doValidation() {
- return toValidationStatus(doConversion());
- }
-
- /**
- * Creates a value context from the current state of the binding and its
- * field.
- *
- * @return the value context
- */
- protected ValueContext createValueContext() {
- if (field instanceof Component) {
- return new ValueContext((Component) field);
- }
- return new ValueContext(findLocale());
- }
-
- /**
- * Sets the field value by invoking the getter function on the given
- * bean. The default listener attached to the field will be removed for
- * the duration of this update.
- *
- * @param bean
- * the bean to fetch the property value from
- */
- private void initFieldValue(BEAN bean) {
- assert bean != null;
- assert onValueChange != null;
- onValueChange.remove();
- try {
- getField().setValue(convertDataToFieldType(bean));
- } finally {
- onValueChange = getField()
- .addValueChangeListener(this::handleFieldValueChange);
- }
- }
-
- private FIELDVALUE convertDataToFieldType(BEAN bean) {
- return converterValidatorChain.convertToPresentation(
- getter.apply(bean), createValueContext());
- }
-
- /**
- * Handles the value change triggered by the bound field.
- *
- * @param bean
- * the new value
- */
- private void handleFieldValueChange(
- ValueChangeEvent<FIELDVALUE> event) {
- getBinder().setHasChanges(true);
- List<ValidationResult> binderValidationResults = Collections
- .emptyList();
- ValidationStatus<TARGET> fieldValidationStatus;
- if (getBinder().getBean().isPresent()) {
- BEAN bean = getBinder().getBean().get();
- fieldValidationStatus = writeFieldValue(bean);
- if (!getBinder().bindings.stream()
- .map(BindingImpl::doValidation)
- .anyMatch(ValidationStatus::isError)) {
- binderValidationResults = getBinder().validateBean(bean);
- if (!binderValidationResults.stream()
- .anyMatch(ValidationResult::isError)) {
- getBinder().setHasChanges(false);
- }
- }
- } else {
- fieldValidationStatus = doValidation();
- }
- BinderValidationStatus<BEAN> status = new BinderValidationStatus<>(
- getBinder(), Arrays.asList(fieldValidationStatus),
- binderValidationResults);
- getBinder().getValidationStatusHandler().accept(status);
- getBinder().fireStatusChangeEvent(status.hasErrors());
- }
-
- /**
- * Write the field value by invoking the setter function on the given
- * bean, if the value passes all registered validators.
- *
- * @param bean
- * the bean to set the property value to
- */
- private ValidationStatus<TARGET> writeFieldValue(BEAN bean) {
- assert bean != null;
-
- Result<TARGET> result = doConversion();
- if (setter != null) {
- result.ifOk(value -> setter.accept(bean, value));
- }
- return toValidationStatus(result);
- }
-
- private void notifyStatusHandler(ValidationStatus<?> status) {
- statusHandler.accept(status);
- }
- }
-
- /**
- * Wraps a validator as a converter.
- * <p>
- * The type of the validator must be of the same type as this converter or a
- * super type of it.
- *
- * @param <T>
- * the type of the converter
- */
- private static class ValidatorAsConverter<T> implements Converter<T, T> {
-
- private final Validator<? super T> validator;
-
- /**
- * Creates a new converter wrapping the given validator.
- *
- * @param validator
- * the validator to wrap
- */
- public ValidatorAsConverter(Validator<? super T> validator) {
- this.validator = validator;
- }
-
- @Override
- public Result<T> convertToModel(T value, ValueContext context) {
- ValidationResult validationResult = validator.apply(value, context);
- if (validationResult.isError()) {
- return Result.error(validationResult.getErrorMessage());
- } else {
- return Result.ok(value);
- }
- }
-
- @Override
- public T convertToPresentation(T value, ValueContext context) {
- return value;
- }
-
- }
-
- /**
- * Converter decorator-strategy pattern to use initially provided "delegate"
- * converter to execute its logic until the {@code setIdentity()} method is
- * called. Once the method is called the class changes its behavior to the
- * same as {@link Converter#identity()} behavior.
- */
- private static class ConverterDelegate<FIELDVALUE>
- implements Converter<FIELDVALUE, FIELDVALUE> {
-
- private Converter<FIELDVALUE, FIELDVALUE> delegate;
-
- private ConverterDelegate(Converter<FIELDVALUE, FIELDVALUE> converter) {
- delegate = converter;
- }
-
- @Override
- public Result<FIELDVALUE> convertToModel(FIELDVALUE value,
- ValueContext context) {
- if (delegate == null) {
- return Result.ok(value);
- } else {
- return delegate.convertToModel(value, context);
- }
- }
-
- @Override
- public FIELDVALUE convertToPresentation(FIELDVALUE value,
- ValueContext context) {
- if (delegate == null) {
- return value;
- } else {
- return delegate.convertToPresentation(value, context);
- }
- }
-
- void setIdentity() {
- delegate = null;
- }
- }
-
- private BEAN bean;
-
- private final Set<BindingImpl<BEAN, ?, ?>> bindings = new LinkedHashSet<>();
-
- private final List<Validator<? super BEAN>> validators = new ArrayList<>();
-
- private final Map<HasValue<?>, ConverterDelegate<?>> initialConverters = new IdentityHashMap<>();
-
- private EventRouter eventRouter;
-
- private Label statusLabel;
-
- private BinderValidationStatusHandler<BEAN> statusHandler;
-
- private boolean hasChanges = false;
-
- /**
- * Returns an {@code Optional} of the bean that has been bound with
- * {@link #bind}, or an empty optional if a bean is not currently bound.
- *
- * @return the currently bound bean if any
- */
- public Optional<BEAN> getBean() {
- return Optional.ofNullable(bean);
- }
-
- /**
- * Creates a new binding for the given field. The returned binding may be
- * further configured before invoking
- * {@link Binding#bind(SerializableFunction, SerializableBiConsumer)} which
- * completes the binding. Until {@code Binding.bind} is called, the binding
- * has no effect.
- * <p>
- * <strong>Note:</strong> Not all {@link HasValue} implementations support
- * passing {@code null} as the value. For these the Binder will
- * automatically change {@code null} to a null representation provided by
- * {@link HasValue#getEmptyValue()}. This conversion is one-way only, if you
- * want to have a two-way mapping back to {@code null}, use
- * {@link Binding#withNullRepresentation(Object))}.
- *
- * @param <FIELDVALUE>
- * the value type of the field
- * @param field
- * the field to be bound, not null
- * @return the new binding
- *
- * @see #bind(HasValue, SerializableFunction, SerializableBiConsumer)
- */
- public <FIELDVALUE> Binding<BEAN, FIELDVALUE> forField(
- HasValue<FIELDVALUE> field) {
- Objects.requireNonNull(field, "field cannot be null");
- // clear previous errors for this field and any bean level validation
- clearError(field);
- getStatusLabel().ifPresent(label -> label.setValue(""));
-
- return createBinding(field, createNullRepresentationAdapter(field),
- this::handleValidationStatus);
- }
-
- /**
- * Binds a field to a bean property represented by the given getter and
- * setter pair. The functions are used to update the field value from the
- * property and to store the field value to the property, respectively.
- * <p>
- * Use the {@link #forField(HasValue)} overload instead if you want to
- * further configure the new binding.
- * <p>
- * <strong>Note:</strong> Not all {@link HasValue} implementations support
- * passing {@code null} as the value. For these the Binder will
- * automatically change {@code null} to a null representation provided by
- * {@link HasValue#getEmptyValue()}. This conversion is one-way only, if you
- * want to have a two-way mapping back to {@code null}, use
- * {@link #forField(HasValue)} and
- * {@link Binding#withNullRepresentation(Object))}.
- * <p>
- * When a bean is bound with {@link Binder#setBean(BEAN)}, the field value
- * is set to the return value of the given getter. The property value is
- * then updated via the given setter whenever the field value changes. The
- * setter may be null; in that case the property value is never updated and
- * the binding is said to be <i>read-only</i>.
- * <p>
- * If the Binder is already bound to some bean, the newly bound field is
- * associated with the corresponding bean property as described above.
- * <p>
- * The getter and setter can be arbitrary functions, for instance
- * implementing user-defined conversion or validation. However, in the most
- * basic use case you can simply pass a pair of method references to this
- * method as follows:
- *
- * <pre>
- * class Person {
- * public String getName() { ... }
- * public void setName(String name) { ... }
- * }
- *
- * TextField nameField = new TextField();
- * binder.bind(nameField, Person::getName, Person::setName);
- * </pre>
- *
- * @param <FIELDVALUE>
- * the value type of the field
- * @param field
- * the field to bind, not null
- * @param getter
- * the function to get the value of the property to the field,
- * not null
- * @param setter
- * the function to write the field value to the property or null
- * if read-only
- */
- public <FIELDVALUE> void bind(HasValue<FIELDVALUE> field,
- SerializableFunction<BEAN, FIELDVALUE> getter,
- SerializableBiConsumer<BEAN, FIELDVALUE> setter) {
- forField(field).bind(getter, setter);
- }
-
- /**
- * Binds the given bean to all the fields added to this Binder. A
- * {@code null} value removes a currently bound bean.
- * <p>
- * When a bean is bound, the field values are updated by invoking their
- * corresponding getter functions. Any changes to field values are reflected
- * back to their corresponding property values of the bean as long as the
- * bean is bound.
- * <p>
- * Any change made in the fields also runs validation for the field
- * {@link Binding} and bean level validation for this binder (bean level
- * validators are added using {@link Binder#withValidator(Validator)}.
- *
- * @see #readBean(Object)
- * @see #writeBean(Object)
- * @see #writeBeanIfValid(Object)
- *
- * @param bean
- * the bean to edit, or {@code null} to remove a currently bound
- * bean
- */
- public void setBean(BEAN bean) {
- if (bean == null) {
- if (this.bean != null) {
- doRemoveBean(true);
- }
- } else {
- doRemoveBean(false);
- this.bean = bean;
- bindings.forEach(b -> b.initFieldValue(bean));
- // if there has been field value change listeners that trigger
- // validation, need to make sure the validation errors are cleared
- getValidationStatusHandler().accept(
- BinderValidationStatus.createUnresolvedStatus(this));
- fireStatusChangeEvent(false);
- }
- }
-
- /**
- * Removes the currently set bean, if any. If there is no bound bean, does
- * nothing.
- * <p>
- * This is a shorthand for {@link #setBean(Object)} with {@code null} bean.
- */
- public void removeBean() {
- setBean(null);
- }
-
- /**
- * Reads the bound property values from the given bean to the corresponding
- * fields.
- * <p>
- * The bean is not otherwise associated with this binder; in particular its
- * property values are not bound to the field value changes. To achieve
- * that, use {@link #setBean(BEAN)}.
- *
- * @see #setBean(Object)
- * @see #writeBeanIfValid(Object)
- * @see #writeBean(Object)
- *
- * @param bean
- * the bean whose property values to read, not null
- */
- public void readBean(BEAN bean) {
- Objects.requireNonNull(bean, "bean cannot be null");
- setHasChanges(false);
- bindings.forEach(binding -> binding.initFieldValue(bean));
-
- getValidationStatusHandler()
- .accept(BinderValidationStatus.createUnresolvedStatus(this));
- fireStatusChangeEvent(false);
- }
-
- /**
- * Writes changes from the bound fields to the given bean if all validators
- * (binding and bean level) pass.
- * <p>
- * If any field binding validator fails, no values are written and a
- * {@code ValidationException} is thrown.
- * <p>
- * If all field level validators pass, the given bean is updated and bean
- * level validators are run on the updated bean. If any bean level validator
- * fails, the bean updates are reverted and a {@code ValidationException} is
- * thrown.
- *
- * @see #writeBeanIfValid(Object)
- * @see #readBean(Object)
- * @see #setBean(Object)
- *
- * @param bean
- * the object to which to write the field values, not
- * {@code null}
- * @throws ValidationException
- * if some of the bound field values fail to validate
- */
- public void writeBean(BEAN bean) throws ValidationException {
- BinderValidationStatus<BEAN> status = doWriteIfValid(bean);
- if (status.hasErrors()) {
- throw new ValidationException(status.getFieldValidationErrors(),
- status.getBeanValidationErrors());
- }
- }
-
- /**
- * Writes changes from the bound fields to the given bean if all validators
- * (binding and bean level) pass.
- * <p>
- * If any field binding validator fails, no values are written and
- * <code>false</code> is returned.
- * <p>
- * If all field level validators pass, the given bean is updated and bean
- * level validators are run on the updated bean. If any bean level validator
- * fails, the bean updates are reverted and <code>false</code> is returned.
- *
- * @see #writeBean(Object)
- * @see #readBean(Object)
- * @see #setBean(Object)
- *
- * @param bean
- * the object to which to write the field values, not
- * {@code null}
- * @return {@code true} if there was no validation errors and the bean was
- * updated, {@code false} otherwise
- */
- public boolean writeBeanIfValid(BEAN bean) {
- return doWriteIfValid(bean).isOk();
- }
-
- /**
- * Writes the field values into the given bean if all field level validators
- * pass. Runs bean level validators on the bean after writing.
- *
- * @param bean
- * the bean to write field values into
- * @return a list of field validation errors if such occur, otherwise a list
- * of bean validation errors.
- */
- @SuppressWarnings({ "rawtypes", "unchecked" })
- private BinderValidationStatus<BEAN> doWriteIfValid(BEAN bean) {
- Objects.requireNonNull(bean, "bean cannot be null");
- // First run fields level validation
- List<ValidationStatus<?>> bindingStatuses = validateBindings();
- // If no validation errors then update bean
- if (bindingStatuses.stream().filter(ValidationStatus::isError).findAny()
- .isPresent()) {
- fireStatusChangeEvent(true);
- return new BinderValidationStatus<>(this, bindingStatuses,
- Collections.emptyList());
- }
-
- // Store old bean values so we can restore them if validators fail
- Map<Binding<BEAN, ?>, Object> oldValues = new HashMap<>();
- bindings.forEach(
- binding -> oldValues.put(binding, binding.getter.apply(bean)));
-
- bindings.forEach(binding -> binding.writeFieldValue(bean));
- // Now run bean level validation against the updated bean
- List<ValidationResult> binderResults = validateBean(bean);
- boolean hasErrors = binderResults.stream()
- .filter(ValidationResult::isError).findAny().isPresent();
- if (hasErrors) {
- // Bean validator failed, revert values
- bindings.forEach((BindingImpl binding) -> binding.setter
- .accept(bean, oldValues.get(binding)));
- } else {
- // Write successful, reset hasChanges to false
- setHasChanges(false);
- }
- fireStatusChangeEvent(hasErrors);
- return new BinderValidationStatus<>(this, bindingStatuses,
- binderResults);
- }
-
- /**
- * Adds an bean level validator.
- * <p>
- * Bean level validators are applied on the bean instance after the bean is
- * updated. If the validators fail, the bean instance is reverted to its
- * previous state.
- *
- * @see #writeBean(Object)
- * @see #writeBeanIfValid(Object)
- * @see #withValidator(SerializablePredicate, String)
- * @see #withValidator(SerializablePredicate, ErrorMessageProvider)
- *
- * @param validator
- * the validator to add, not null
- * @return this binder, for chaining
- */
- public Binder<BEAN> withValidator(Validator<? super BEAN> validator) {
- Objects.requireNonNull(validator, "validator cannot be null");
- validators.add(validator);
- return this;
- }
-
- /**
- * A convenience method to add a validator to this binder using the
- * {@link Validator#from(SerializablePredicate, String)} factory method.
- * <p>
- * Bean level validators are applied on the bean instance after the bean is
- * updated. If the validators fail, the bean instance is reverted to its
- * previous state.
- *
- * @see #writeBean(Object)
- * @see #writeBeanIfValid(Object)
- * @see #withValidator(Validator)
- * @see #withValidator(SerializablePredicate, ErrorMessageProvider)
- *
- * @param predicate
- * the predicate performing validation, not null
- * @param message
- * the error message to report in case validation failure
- * @return this binder, for chaining
- */
- public Binder<BEAN> withValidator(SerializablePredicate<BEAN> predicate,
- String message) {
- return withValidator(Validator.from(predicate, message));
- }
-
- /**
- * A convenience method to add a validator to this binder using the
- * {@link Validator#from(SerializablePredicate, ErrorMessageProvider)}
- * factory method.
- * <p>
- * Bean level validators are applied on the bean instance after the bean is
- * updated. If the validators fail, the bean instance is reverted to its
- * previous state.
- *
- * @see #writeBean(Object)
- * @see #writeBeanIfValid(Object)
- * @see #withValidator(Validator)
- * @see #withValidator(SerializablePredicate, String)
- *
- * @param predicate
- * the predicate performing validation, not null
- * @param errorMessageProvider
- * the provider to generate error messages, not null
- * @return this binder, for chaining
- */
- public Binder<BEAN> withValidator(SerializablePredicate<BEAN> predicate,
- ErrorMessageProvider errorMessageProvider) {
- return withValidator(Validator.from(predicate, errorMessageProvider));
- }
-
- /**
- * Validates the values of all bound fields and returns the validation
- * status.
- * <p>
- * If all field level validators pass, and {@link #setBean(Object)} has been
- * used to bind to a bean, bean level validators are run for that bean. Bean
- * level validators are ignored if there is no bound bean or if any field
- * level validator fails.
- * <p>
- *
- * @return validation status for the binder
- */
- public BinderValidationStatus<BEAN> validate() {
- List<ValidationStatus<?>> bindingStatuses = validateBindings();
-
- BinderValidationStatus<BEAN> validationStatus;
- if (bindingStatuses.stream().filter(ValidationStatus::isError).findAny()
- .isPresent() || bean == null) {
- validationStatus = new BinderValidationStatus<>(this,
- bindingStatuses, Collections.emptyList());
- } else {
- validationStatus = new BinderValidationStatus<>(this,
- bindingStatuses, validateBean(bean));
- }
- getValidationStatusHandler().accept(validationStatus);
- fireStatusChangeEvent(validationStatus.hasErrors());
- return validationStatus;
- }
-
- /**
- * Validates the bindings and returns the result of the validation as a list
- * of validation statuses.
- * <p>
- * Does not run bean validators.
- *
- * @see #validateBean(Object)
- *
- * @return an immutable list of validation results for bindings
- */
- private List<ValidationStatus<?>> validateBindings() {
- List<ValidationStatus<?>> results = new ArrayList<>();
- for (BindingImpl<?, ?, ?> binding : bindings) {
- results.add(binding.doValidation());
- }
- return results;
- }
-
- /**
- * Validates the {@code bean} using validators added using
- * {@link #withValidator(Validator)} and returns the result of the
- * validation as a list of validation results.
- * <p>
- *
- * @see #withValidator(Validator)
- *
- * @param bean
- * the bean to validate
- * @return a list of validation errors or an empty list if validation
- * succeeded
- */
- private List<ValidationResult> validateBean(BEAN bean) {
- Objects.requireNonNull(bean, "bean cannot be null");
- List<ValidationResult> results = Collections.unmodifiableList(validators
- .stream()
- .map(validator -> validator.apply(bean, new ValueContext()))
- .collect(Collectors.toList()));
- return results;
- }
-
- /**
- * Sets the label to show the binder level validation errors not related to
- * any specific field.
- * <p>
- * Only the one validation error message is shown in this label at a time.
- * <p>
- * This is a convenience method for
- * {@link #setValidationStatusHandler(BinderStatusHandler)}, which means
- * that this method cannot be used after the handler has been set. Also the
- * handler cannot be set after this label has been set.
- *
- * @param statusLabel
- * the status label to set
- * @see #setValidationStatusHandler(BinderStatusHandler)
- * @see Binding#withStatusLabel(Label)
- */
- public void setStatusLabel(Label statusLabel) {
- if (statusHandler != null) {
- throw new IllegalStateException("Cannot set status label if a "
- + BinderValidationStatusHandler.class.getSimpleName()
- + " has already been set.");
- }
- this.statusLabel = statusLabel;
- }
-
- /**
- * Gets the status label or an empty optional if none has been set.
- *
- * @return the optional status label
- * @see #setStatusLabel(Label)
- */
- public Optional<Label> getStatusLabel() {
- return Optional.ofNullable(statusLabel);
- }
-
- /**
- * Sets the status handler to track form status changes.
- * <p>
- * Setting this handler will override the default behavior, which is to let
- * fields show their validation status messages and show binder level
- * validation errors or OK status in the label set with
- * {@link #setStatusLabel(Label)}.
- * <p>
- * This handler cannot be set after the status label has been set with
- * {@link #setStatusLabel(Label)}, or {@link #setStatusLabel(Label)} cannot
- * be used after this handler has been set.
- *
- * @param statusHandler
- * the status handler to set, not <code>null</code>
- * @throws NullPointerException
- * for <code>null</code> status handler
- * @see #setStatusLabel(Label)
- * @see Binding#withValidationStatusHandler(ValidationStatusHandler)
- */
- public void setValidationStatusHandler(
- BinderValidationStatusHandler<BEAN> statusHandler) {
- Objects.requireNonNull(statusHandler, "Cannot set a null "
- + BinderValidationStatusHandler.class.getSimpleName());
- if (statusLabel != null) {
- throw new IllegalStateException("Cannot set "
- + BinderValidationStatusHandler.class.getSimpleName()
- + " if a status label has already been set.");
- }
- this.statusHandler = statusHandler;
- }
-
- /**
- * Gets the status handler of this form.
- * <p>
- * If none has been set with
- * {@link #setValidationStatusHandler(BinderStatusHandler)}, the default
- * implementation is returned.
- *
- * @return the status handler used, never <code>null</code>
- * @see #setValidationStatusHandler(BinderStatusHandler)
- */
- public BinderValidationStatusHandler<BEAN> getValidationStatusHandler() {
- return Optional.ofNullable(statusHandler)
- .orElse(this::handleBinderValidationStatus);
- }
-
- /**
- * Adds status change listener to the binder.
- * <p>
- * The {@link Binder} status is changed whenever any of the following
- * happens:
- * <ul>
- * <li>if it's bound and any of its bound field or select has been changed
- * <li>{@link #writeBean(Object)} or {@link #writeBeanIfValid(Object)} is
- * called
- * <li>{@link #readBean(Object)} is called
- * <li>{@link #setBean(Object)} is called
- * <li>{@link #removeBean()} is called
- * <li>{@link Binding#bind(SerializableFunction, SerializableBiConsumer)} is
- * called
- * <li>{@link Binder#validate()} or {@link Binding#validate()} is called
- * </ul>
- *
- * @see #readBean(Object)
- * @see #writeBean(Object)
- * @see #writeBeanIfValid(Object)
- * @see #setBean(Object)
- * @see #removeBean()
- * @see #forField(HasValue)
- * @see #forSelect(AbstractMultiSelect)
- * @see #validate()
- * @see Binding#validate()
- * @see Binding#bind(Object)
- *
- * @param listener
- * status change listener to add, not null
- * @return a registration for the listener
- */
- public Registration addStatusChangeListener(StatusChangeListener listener) {
- return getEventRouter().addListener(StatusChangeEvent.class, listener,
- StatusChangeListener.class.getDeclaredMethods()[0]);
- }
-
- /**
- * Creates a new binding with the given field.
- *
- * @param <FIELDVALUE>
- * the value type of the field
- * @param <TARGET>
- * the target data type
- * @param field
- * the field to bind, not null
- * @param converter
- * the converter for converting between FIELDVALUE and TARGET
- * types, not null
- * @param handler
- * the handler to notify of status changes, not null
- * @return the new incomplete binding
- */
- protected <FIELDVALUE, TARGET> Binding<BEAN, TARGET> createBinding(
- HasValue<FIELDVALUE> field, Converter<FIELDVALUE, TARGET> converter,
- ValidationStatusHandler handler) {
- return new BindingImpl<>(this, field, converter, handler);
- }
-
- /**
- * Clears the error condition of the given field, if any. The default
- * implementation clears the
- * {@link AbstractComponent#setComponentError(ErrorMessage) component error}
- * of the field if it is a Component, otherwise does nothing.
- *
- * @param field
- * the field with an invalid value
- */
- protected void clearError(HasValue<?> field) {
- if (field instanceof AbstractComponent) {
- ((AbstractComponent) field).setComponentError(null);
- }
- }
-
- /**
- * Handles a validation error emitted when trying to write the value of the
- * given field. The default implementation sets the
- * {@link AbstractComponent#setComponentError(ErrorMessage) component error}
- * of the field if it is a Component, otherwise does nothing.
- *
- * @param field
- * the field with the invalid value
- * @param error
- * the error message to set
- */
- protected void handleError(HasValue<?> field, String error) {
- if (field instanceof AbstractComponent) {
- ((AbstractComponent) field).setComponentError(new UserError(error));
- }
-
- }
-
- /**
- * Default {@link ValidationStatusHandler} functional method implementation.
- *
- * @param status
- * the validation status
- */
- protected void handleValidationStatus(ValidationStatus<?> status) {
- HasValue<?> source = status.getField();
- clearError(source);
- if (status.isError()) {
- handleError(source, status.getMessage().get());
- }
- }
-
- /**
- * Returns the bindings for this binder.
- *
- * @return a set of the bindings
- */
- protected Set<BindingImpl<BEAN, ?, ?>> getBindings() {
- return bindings;
- }
-
- /**
- * The default binder level status handler.
- * <p>
- * Passes all field related results to the Binding status handlers. All
- * other status changes are displayed in the status label, if one has been
- * set with {@link #setStatusLabel(Label)}.
- *
- * @param binderStatus
- * status of validation results from binding and/or bean level
- * validators
- */
- protected void handleBinderValidationStatus(
- BinderValidationStatus<BEAN> binderStatus) {
- // let field events go to binding status handlers
- binderStatus.getFieldValidationStatuses()
- .forEach(status -> ((BindingImpl<?, ?, ?>) status.getBinding())
- .notifyStatusHandler(status));
-
- // show first possible error or OK status in the label if set
- if (getStatusLabel().isPresent()) {
- String statusMessage = binderStatus.getBeanValidationErrors()
- .stream().findFirst().map(ValidationResult::getErrorMessage)
- .orElse("");
- getStatusLabel().get().setValue(statusMessage);
- }
- }
-
- /**
- * Sets whether the values of the fields this binder is bound to have
- * changed since the last explicit call to either bind, write or read.
- *
- * @param hasChanges
- * whether this binder should be marked to have changes
- */
- private void setHasChanges(boolean hasChanges) {
- this.hasChanges = hasChanges;
- }
-
- /**
- * Check whether any of the bound fields' values have changed since last
- * explicit call to {@link #setBean(Object)}, {@link #readBean(Object)},
- * {@link #removeBean()}, {@link #writeBean(Object)} or
- * {@link #writeBeanIfValid(Object)}. Unsuccessful write operations will not
- * affect this value. Return values for each case are compiled into the
- * following table:
- *
- * <p>
- *
- * <table>
- * <tr>
- * <td></td>
- * <td>After readBean, setBean or removeBean</td>
- * <td>After valid user changes</td>
- * <td>After invalid user changes</td>
- * <td>After successful writeBean or writeBeanIfValid</td>
- * <td>After unsuccessful writeBean or writeBeanIfValid</td>
- * </tr>
- * <tr>
- * <td>A bean is currently bound</td>
- * <td>{@code false}</td>
- * <td>{@code false}</td>
- * <td>{@code true}</td>
- * <td>{@code false}</td>
- * <td>no change</td>
- * </tr>
- * <tr>
- * <td>No bean is currently bound</td>
- * <td>{@code false}</td>
- * <td>{@code true}</td>
- * <td>{@code true}</td>
- * <td>{@code false}</td>
- * <td>no change</td>
- * </tr>
- * </table>
- *
- * @return whether any bound field's value has changed since last call to
- * setBean, readBean, writeBean or writeBeanIfValid
- */
- public boolean hasChanges() {
- return hasChanges;
- }
-
- /**
- * Returns the event router for this binder.
- *
- * @return the event router, not null
- */
- protected EventRouter getEventRouter() {
- if (eventRouter == null) {
- eventRouter = new EventRouter();
- }
- return eventRouter;
- }
-
- private void doRemoveBean(boolean fireStatusEvent) {
- setHasChanges(false);
- if (bean != null) {
- bean = null;
- }
- getValidationStatusHandler()
- .accept(BinderValidationStatus.createUnresolvedStatus(this));
- if (fireStatusEvent) {
- fireStatusChangeEvent(false);
- }
- }
-
- private void fireStatusChangeEvent(boolean hasValidationErrors) {
- getEventRouter()
- .fireEvent(new StatusChangeEvent(this, hasValidationErrors));
- }
-
- private <FIELDVALUE> Converter<FIELDVALUE, FIELDVALUE> createNullRepresentationAdapter(
- HasValue<FIELDVALUE> field) {
- Converter<FIELDVALUE, FIELDVALUE> nullRepresentationConverter = Converter
- .from(fieldValue -> fieldValue,
- modelValue -> Objects.isNull(modelValue)
- ? field.getEmptyValue() : modelValue,
- exception -> exception.getMessage());
- ConverterDelegate<FIELDVALUE> converter = new ConverterDelegate<>(
- nullRepresentationConverter);
- initialConverters.put(field, converter);
- return converter;
- }
-
- }
|