com.github.richardballard.arbeeutils.id.ByIdSpecifiers.java Source code

Introduction

Here is the source code for com.github.richardballard.arbeeutils.id.ByIdSpecifiers.java

Source

/*
 * (C) Copyright 2016 Richard Ballard.
 *
 * 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 com.github.richardballard.arbeeutils.id;

import com.google.common.collect.ImmutableSet;
import net.jcip.annotations.Immutable;
import org.jetbrains.annotations.NotNull;

/**
 * This class has static methods for obtaining the various flavours of {@link ByIdSpecifier}.
 */
@SuppressWarnings("StaticMethodOnlyUsedInOneClass")
@Immutable
public enum ByIdSpecifiers {
    ;

    private static final ByIdSpecifier<Object> EXCLUDE_NONE = new AllBasedByIdSpecifier<>(ImmutableSet.of());
    private static final ByIdSpecifier<Object> INCLUDE_NONE = new NoneBasedByIdSpecifier<>(ImmutableSet.of());

    /**
     * @return an instance that excludes nothing (i.e. includes everything)
     */
    @SuppressWarnings("unchecked")
    public static @NotNull <T> ByIdSpecifier<T> excludeNone() {
        return (ByIdSpecifier<T>) EXCLUDE_NONE;
    }

    /**
     * @return an instance that excludes everything (i.e. includes nothing)
     */
    public static @NotNull <T> ByIdSpecifier<T> excludeAll() {
        return includeNone();
    }

    /**
     * @return an instance that excludes only the specified ids
     */
    public static @NotNull <T> ByIdSpecifier<T> excludeOnly(final @NotNull Iterable<? extends T> exclusions) {

        return new AllBasedByIdSpecifier<>(ImmutableSet.copyOf(exclusions));
    }

    /**
     * @return an instance that excludes only the specified id
     */
    public static @NotNull <T> ByIdSpecifier<T> excludeOnly(final @NotNull T exclusion) {

        return new AllBasedByIdSpecifier<>(ImmutableSet.of(exclusion));
    }

    /**
     * @return an instance that includes nothing (i.e. excludes everything)
     */
    @SuppressWarnings("unchecked")
    public static @NotNull <T> ByIdSpecifier<T> includeNone() {
        return (ByIdSpecifier<T>) INCLUDE_NONE;
    }

    /**
     * @return an instance that includes everything (i.e. excludes nothing)
     */
    public static @NotNull <T> ByIdSpecifier<T> includeAll() {
        return excludeNone();
    }

    /**
     * @return an instance that includes only the specified ids
     */
    public static @NotNull <T> ByIdSpecifier<T> includeOnly(final @NotNull Iterable<? extends T> inclusions) {

        return new NoneBasedByIdSpecifier<>(ImmutableSet.copyOf(inclusions));
    }

    /**
     * @return an instance that includes only the specified id
     */
    public static @NotNull <T> ByIdSpecifier<T> includeOnly(final @NotNull T inclusion) {

        return new NoneBasedByIdSpecifier<>(ImmutableSet.of(inclusion));
    }
}