io.github.palexdev.mfxcore.filter.BooleanFilter 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.filter;

import io.github.palexdev.mfxcore.base.beans.BiPredicateBean;
import io.github.palexdev.mfxcore.filter.base.AbstractFilter;
import io.github.palexdev.mfxcore.utils.fx.FXCollectors;
import io.github.palexdev.mfxlocalization.I18N;
import javafx.collections.ObservableList;
import javafx.util.StringConverter;
import javafx.util.converter.BooleanStringConverter;

import java.util.Collections;
import java.util.function.Function;
import java.util.stream.Stream;

/**
 * Extension of {@link AbstractFilter} for boolean fields.
 * 
 * Offers the following default {@link BiPredicateBean}s:
 *  - "is": checks for booleans equality
 *  - "is not": checks for booleans inequality
 */
public class BooleanFilter extends AbstractFilter {

	//================================================================================
	// Constructors
	//================================================================================
	public BooleanFilter(String name, Function extractor) {
		this(name, extractor, new BooleanStringConverter());
	}

	public BooleanFilter(String name, Function extractor, StringConverter converter) {
		super(name, extractor, converter);
	}

	//================================================================================
	// Overridden Methods
	//================================================================================
	@Override
	protected ObservableList> defaultPredicates() {
		return Stream.>of(
				new BiPredicateBean<>(I18N.getOrDefault("filter.is"), Boolean::equals),
				new BiPredicateBean<>(I18N.getOrDefault("filter.isNot"), (aBoolean, aBoolean2) -> !aBoolean.equals(aBoolean2))
		).collect(FXCollectors.toList());
	}

	@SafeVarargs
	@Override
	protected final BooleanFilter extend(BiPredicateBean... predicateBeans) {
		Collections.addAll(super.predicates, predicateBeans);
		return this;
	}
}