org.cactoos.scalar.Xor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cactoos Show documentation
Object-oriented Java Primitives
There is a newer version: 0.56.1
/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2017-2022 Yegor Bugayenko
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package org.cactoos.scalar;

import org.cactoos.Scalar;
import org.cactoos.iterable.IterableOf;
import org.cactoos.iterable.Joined;

/**
 * Logical exclusive or.

 * Returns {@link True} when an odd number of elements have value true,
 * otherwise return {@link False}.
 *
 * This class could be also used for matching multiple boolean
 * expressions:
 *
 * {@code
 * new Xor(
 *    new True(),
 *    new True(),
 *    new True()
 * ).value(); // the result is true
 *
 * new Xor(
 *    new True(),
 *    new False(),
 *    new True()
 * ).value(); // the result is false
 * }
 *
 * This class implements {@link Scalar}, which throws a checked
 * {@link Exception}. This may not be convenient in many cases. To make
 * it more convenient and get rid of the checked exception you can
 * use the {@link Unchecked} decorator. Or you may use
 * {@link IoChecked} to wrap it in an IOException.
 *
 * There is no thread-safety guarantee.
 *
 * @see Unchecked
 * @see IoChecked
 * @since 0.49
 */
public final class Xor extends ScalarEnvelope {

    /**
     * Ctor.
     * @param scalar The Scalar.
     */
    @SafeVarargs
    public Xor(final Scalar... scalar) {
        this(new IterableOf<>(scalar));
    }

    /**
     * Ctor.
     * @param iterable The iterable.
     */
    public Xor(final Iterable> iterable) {
        super(new Reduced<>((a, b) -> a ^ b, new Joined<>(new False(), iterable))
        );
    }
}