All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.groupbyinc.common.apache.commons.collections4.functors.IfClosure Maven / Gradle / Ivy

There is a newer version: 198
Show newest version
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.commons.collections4.functors;

import java.io.Serializable;

import org.apache.commons.collections4.Closure;
import org.apache.commons.collections4.Predicate;

/**
 * Closure implementation acts as an if statement calling one or other closure
 * based on a predicate.
 *
 * @since 3.0
 * @version $Id: IfClosure.java 1686855 2015-06-22 13:00:27Z tn $
 */
public class IfClosure implements Closure, Serializable {

    /** Serial version UID */
    private static final long serialVersionUID = 3518477308466486130L;

    /** The test */
    private final Predicate iPredicate;
    /** The closure to use if true */
    private final Closure iTrueClosure;
    /** The closure to use if false */
    private final Closure iFalseClosure;

    /**
     * Factory method that performs validation.
     * 

* This factory creates a closure that performs no action when * the predicate is false. * * @param the type that the closure acts on * @param predicate predicate to switch on * @param trueClosure closure used if true * @return the if closure * @throws NullPointerException if either argument is null * @since 3.2 */ public static Closure ifClosure(final Predicate predicate, final Closure trueClosure) { return IfClosure.ifClosure(predicate, trueClosure, NOPClosure.nopClosure()); } /** * Factory method that performs validation. * * @param the type that the closure acts on * @param predicate predicate to switch on * @param trueClosure closure used if true * @param falseClosure closure used if false * @return the if closure * @throws NullPointerException if any argument is null */ public static Closure ifClosure(final Predicate predicate, final Closure trueClosure, final Closure falseClosure) { if (predicate == null) { throw new NullPointerException("Predicate must not be null"); } if (trueClosure == null || falseClosure == null) { throw new NullPointerException("Closures must not be null"); } return new IfClosure(predicate, trueClosure, falseClosure); } /** * Constructor that performs no validation. * Use ifClosure if you want that. *

* This constructor creates a closure that performs no action when * the predicate is false. * * @param predicate predicate to switch on, not null * @param trueClosure closure used if true, not null * @since 3.2 */ public IfClosure(final Predicate predicate, final Closure trueClosure) { this(predicate, trueClosure, NOPClosure.nopClosure()); } /** * Constructor that performs no validation. * Use ifClosure if you want that. * * @param predicate predicate to switch on, not null * @param trueClosure closure used if true, not null * @param falseClosure closure used if false, not null */ public IfClosure(final Predicate predicate, final Closure trueClosure, final Closure falseClosure) { super(); iPredicate = predicate; iTrueClosure = trueClosure; iFalseClosure = falseClosure; } /** * Executes the true or false closure according to the result of the predicate. * * @param input the input object */ public void execute(final E input) { if (iPredicate.evaluate(input)) { iTrueClosure.execute(input); } else { iFalseClosure.execute(input); } } /** * Gets the predicate. * * @return the predicate * @since 3.1 */ public Predicate getPredicate() { return iPredicate; } /** * Gets the closure called when true. * * @return the closure * @since 3.1 */ public Closure getTrueClosure() { return iTrueClosure; } /** * Gets the closure called when false. * * @return the closure * @since 3.1 */ public Closure getFalseClosure() { return iFalseClosure; } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy