io.github.palexdev.materialfx.bindings.BiBindingBuilder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of materialfx Show documentation
Material Desgin components for JavaFX
There is a newer version: 11.17.0
/*
 * Copyright (C) 2022 Parisi Alessandro
 * This file is part of MaterialFX (https://github.com/palexdev/MaterialFX).
 *
 * MaterialFX is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * MaterialFX is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with MaterialFX.  If not, see .
 */

package io.github.palexdev.materialfx.bindings;

import javafx.beans.property.Property;
import javafx.beans.value.ObservableValue;

import java.util.Map;
import java.util.function.BiConsumer;

/**
 * Helper class for {@link BiBindingManager}.
 * 
 * Makes the creation of bidirectional bindings easier with fluent methods.
 */
public class BiBindingBuilder {
	//================================================================================
	// Properties
	//================================================================================
	private final ObservableValue target;
	private BiConsumer targetUpdater;
	private final BindingsMap, BiConsumer> sources = new BindingsMap<>();
	private BiBindingHelper bindingHelper;
	private boolean eagerEvaluation = true;
	private boolean override = false;

	//================================================================================
	// Constructors
	//================================================================================
	public BiBindingBuilder(ObservableValue target) {
		this.target = target;
	}

	//================================================================================
	// Methods
	//================================================================================

	/**
	 * Sets the {@link BiConsumer} function responsible for updating the target
	 * when the source changes.
	 */
	public BiBindingBuilder with(BiConsumer targetUpdater) {
		this.targetUpdater = targetUpdater;
		return this;
	}

	/**
	 * Specifies the {@link BiBindingHelper} that will be used for the binding.
	 * 
	 * This is optional as a default helper will be created when needed.
	 */
	public BiBindingBuilder withHelper(BiBindingHelper bindingHelper) {
		this.bindingHelper = bindingHelper;
		return this;
	}

	/**
	 * Calls {@link #to(ObservableValue, BiConsumer)} with the given property.
	 * Since it is a {@link Property} the {@link BiConsumer} will make use of {@link Property#setValue(Object)}.
	 */
	public BiBindingBuilder to(Property source) {
		return to(source, (oldValue, newValue) -> source.setValue(newValue));
	}

	/**
	 * Adds a new entry in the map which associates the given source to the given
	 * {@link BiConsumer} that is responsible for updating the source when needed.
	 */
	public BiBindingBuilder to(ObservableValue source, BiConsumer sourceUpdater) {
		this.sources.put(source, sourceUpdater);
		return this;
	}

	/**
	 * Allows adding multiple entries to the map at once.
	 * Basically the same as {@link #to(ObservableValue, BiConsumer)}.
	 */
	@SafeVarargs
	public final BiBindingBuilder to(Map.Entry, BiConsumer>... sources) {
		this.sources.putAll(sources);
		return this;
	}

	/**
	 * Disables the binding eager evaluation mechanism.
	 * At the time of the binding the values won't be updated automatically.
	 */
	public BiBindingBuilder lazy() {
		this.eagerEvaluation = false;
		return this;
	}

	/**
	 * If a binding for the specified target is already present specifies
	 * if this builder's targetUpdater must replace the existing one.
	 */
	public BiBindingBuilder override(boolean override) {
		this.override = override;
		return this;
	}

	/**
	 * @return the target observable
	 */
	public ObservableValue target() {
		return target;
	}

	/**
	 * @return the target updater
	 */
	public BiConsumer targetUpdater() {
		return targetUpdater;
	}

	/**
	 * @return the map containing the sources and their updater
	 */
	public BindingsMap, BiConsumer> getSources() {
		return sources;
	}

	/**
	 * @return if the bindings uses eager evaluation or it's lazy
	 */
	public boolean isEagerEvaluation() {
		return eagerEvaluation;
	}

	/**
	 * Confirms the creation of the binding by calling {@link BiBindingManager#apply(BiBindingBuilder, BiBindingHelper, boolean)}.
	 */
	public BiBindingManager create() {
		return BiBindingManager.instance().apply(this, bindingHelper, override);
	}
}