rx.internal.util.UtilityFunctions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rxjava Show documentation
rxjava
There is a newer version: 1.3.8
/**
 * Copyright 2014 Netflix, Inc.
 * 
 * Licensed 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 rx.internal.util;

import rx.functions.Func1;

/**
 * Utility functions for internal use that we don't want part of the public API. 
 */
public final class UtilityFunctions {

    /** Utility class. */
    private UtilityFunctions() {
        throw new IllegalStateException("No instances!");
    }
    
    /**
     * Returns a function that always returns {@code true}.
     *
     * @param  the value type
     * @return a {@link Func1} that accepts an Object and returns the Boolean {@code true}
     */
    public static  Func1 alwaysTrue() {
        return AlwaysTrue.INSTANCE;
    }

    /**
     * Returns a function that always returns {@code false}.
     *
     * @param  the value type
     * @return a {@link Func1} that accepts an Object and returns the Boolean {@code false}
     */
    public static  Func1 alwaysFalse() {
        return AlwaysFalse.INSTANCE;
    }

    /**
     * Returns a function that always returns the Object it is passed.
     *
     * @param  the input and output value type
     * @return a {@link Func1} that accepts an Object and returns the same Object
     */
    public static  Func1 identity() {
        return new Func1() {
            @Override
            public T call(T o) {
                return o;
            }
        };
    }

    enum AlwaysTrue implements Func1 {
        INSTANCE;

        @Override
        public Boolean call(Object o) {
            return true;
        }
    }

    enum AlwaysFalse implements Func1 {
        INSTANCE;

        @Override
        public Boolean call(Object o) {
            return false;
        }
    }
}