io.github.palexdev.mfxcore.validation.Constraint Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of materialfx-all Show documentation
Material Design/Modern components for JavaFX, now packed as a single Jar
There is a newer version: 11.26.0
/*
 * Copyright (C) 2022 Parisi Alessandro - [email protected]
 * 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.mfxcore.validation;

import io.github.palexdev.mfxcore.enums.ChainMode;
import io.github.palexdev.mfxcore.observables.When;
import javafx.beans.binding.BooleanExpression;

/**
 * Bean used by {@link MFXValidator} to define a condition to be met in order
 * for the validator' state to be valid.
 * 
 * This bean allows to specify the {@link Severity} of the condition, the message
 * to show when invalid, and of course the {@link BooleanExpression} that is the condition itself.
 * 
 * It also allows to specify how this constraint should chain with others by setting its {@link ChainMode},
 * {@link #setChainMode(ChainMode)}.
 * 

 * To build a constraint you can use the offered static methods, the {@link Builder}, or the parameterized constructors.
 */
public class Constraint {
	//================================================================================
	// Properties
	//================================================================================
	private Severity severity;
	private String message;
	private BooleanExpression condition;
	private ChainMode chainMode = ChainMode.AND;

	protected When when;

	//================================================================================
	// Constructors
	//================================================================================
	protected Constraint() {
	}

	/**
	 * Calls {@link #Constraint(Severity, String, BooleanExpression)} with {@link Severity#ERROR}.
	 */
	public Constraint(String message, BooleanExpression condition) {
		this(Severity.ERROR, message, condition);
	}

	public Constraint(Severity severity, String message, BooleanExpression condition) {
		if (condition == null) {
			throw new NullPointerException("The condition cannot be null!");
		}
		this.severity = severity;
		this.message = message;
		this.condition = condition;
	}

	//================================================================================
	// Static Methods
	//================================================================================

	/**
	 * @return a new {@code Constraint} with ERROR severity and the given message and condition
	 */
	public static Constraint of(String message, BooleanExpression condition) {
		return new Constraint(message, condition);
	}

	/**
	 * @return a new {@code Constraint} with the given severity, message and condition
	 */
	public static Constraint of(Severity severity, String message, BooleanExpression condition) {
		return new Constraint(severity, message, condition);
	}

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

	/**
	 * Used by {@link MFXValidator} when the constraint in being removed from it.
	 * 
	 * Upon its creation a listener is added to update the validator with the {@link When}
	 * construct. Since we need the instance to properly dispose it afterward, we store the reference here,
	 * the disposal can then be easily automatically handled by {@link MFXValidator#removeConstraint(Constraint)}.
	 */
	protected void dispose() {
		if (when != null) when.dispose();
	}

	//================================================================================
	// Getters/Setters
	//================================================================================

	/**
	 * @return whether the specified condition is valid
	 */
	public boolean isValid() {
		return condition.getValue();
	}

	/**
	 * @return the severity of the condition
	 */
	public Severity getSeverity() {
		return severity;
	}

	/**
	 * Sets the severity of the condition.
	 */
	protected void setSeverity(Severity severity) {
		this.severity = severity;
	}

	/**
	 * @return the message to show in case the condition is not valid
	 */
	public String getMessage() {
		return message;
	}

	/**
	 * Sets the message to show in case the condition is not valid.
	 */
	protected void setMessage(String message) {
		this.message = message;
	}

	/**
	 * @return the {@link BooleanExpression} used to define the condition
	 */
	public BooleanExpression getCondition() {
		return condition;
	}

	/**
	 * Sets the {@link BooleanExpression} used to define the condition.
	 */
	protected void setCondition(BooleanExpression condition) {
		this.condition = condition;
	}

	/**
	 * @return the mode defining how this constraint will be chained to other constraints
	 */
	public ChainMode getChainMode() {
		return chainMode;
	}

	/**
	 * Sets the mode defining how this constraint will be chained to other constraints.
	 */
	public Constraint setChainMode(ChainMode chainMode) {
		this.chainMode = chainMode;
		return this;
	}

	//================================================================================
	// Builder Class
	//================================================================================
	public static class Builder {
		private final Constraint constraint = new Constraint();

		public static Builder build() {
			return new Builder();
		}

		public Builder setSeverity(Severity severity) {
			constraint.setSeverity(severity);
			return this;
		}

		public Builder setMessage(String message) {
			constraint.setMessage(message);
			return this;
		}

		public Builder setCondition(BooleanExpression condition) {
			constraint.setCondition(condition);
			return this;
		}

		public Builder setChainMode(ChainMode mode) {
			constraint.setChainMode(mode);
			return this;
		}

		public Constraint get() {
			checkConstraint();
			return constraint;
		}

		private void checkConstraint() {
			Severity severity = constraint.getSeverity();
			BooleanExpression condition = constraint.getCondition();

			if (severity == null) throw new IllegalArgumentException("Severity not set!");
			if (condition == null) throw new IllegalArgumentException("Condition not set!");
		}
	}
}