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

com.landawn.abacus.util.ImmutableSet Maven / Gradle / Ivy

Go to download

A general programming library in Java/Android. It's easy to learn and simple to use with concise and powerful APIs.

There is a newer version: 5.2.4
Show newest version
/*
 * Copyright (C) 2016 HaiYang Li
 *
 * 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.landawn.abacus.util;

import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedHashSet;
import java.util.Set;
import java.util.SortedSet;

/**
 *
 * @author Haiyang Li
 * @param 
 * @since 0.8
 */
public class ImmutableSet extends ImmutableCollection implements Set {

    @SuppressWarnings("rawtypes")
    private static final ImmutableSet EMPTY = new ImmutableSet(Collections.emptySet());

    ImmutableSet(Set set) {
        super(Collections.unmodifiableSet(set));
    }

    /**
     *
     * @param 
     * @return
     */
    public static  ImmutableSet empty() {
        return EMPTY;
    }

    /**
     * 
     *
     * @param  
     * @param e 
     * @return 
     */
    public static  ImmutableSet just(T e) {
        return new ImmutableSet<>(Collections.singleton(e));
    }

    /**
     * 
     *
     * @param  
     * @param e1 
     * @return 
     */
    public static  ImmutableSet of(final T e1) {
        return new ImmutableSet<>(N.asSet(e1));
    }

    /**
     * 
     *
     * @param  
     * @param e1 
     * @param e2 
     * @return 
     */
    public static  ImmutableSet of(final T e1, final T e2) {
        return new ImmutableSet<>(N.asSet(e1, e2));
    }

    /**
     * 
     *
     * @param  
     * @param e1 
     * @param e2 
     * @param e3 
     * @return 
     */
    public static  ImmutableSet of(final T e1, final T e2, final T e3) {
        return new ImmutableSet<>(N.asSet(e1, e2, e3));
    }

    /**
     * 
     *
     * @param  
     * @param e1 
     * @param e2 
     * @param e3 
     * @param e4 
     * @return 
     */
    public static  ImmutableSet of(final T e1, final T e2, final T e3, final T e4) {
        return new ImmutableSet<>(N.asSet(e1, e2, e3, e4));
    }

    /**
     * 
     *
     * @param  
     * @param e1 
     * @param e2 
     * @param e3 
     * @param e4 
     * @param e5 
     * @return 
     */
    public static  ImmutableSet of(final T e1, final T e2, final T e3, final T e4, final T e5) {
        return new ImmutableSet<>(N.asSet(e1, e2, e3, e4, e5));
    }

    /**
     * 
     *
     * @param  
     * @param e1 
     * @param e2 
     * @param e3 
     * @param e4 
     * @param e5 
     * @param e6 
     * @return 
     */
    public static  ImmutableSet of(final T e1, final T e2, final T e3, final T e4, final T e5, final T e6) {
        return new ImmutableSet<>(N.asSet(e1, e2, e3, e4, e5, e6));
    }

    /**
     * 
     *
     * @param  
     * @param e1 
     * @param e2 
     * @param e3 
     * @param e4 
     * @param e5 
     * @param e6 
     * @param e7 
     * @return 
     */
    public static  ImmutableSet of(final T e1, final T e2, final T e3, final T e4, final T e5, final T e6, final T e7) {
        return new ImmutableSet<>(N.asSet(e1, e2, e3, e4, e5, e6, e7));
    }

    /**
     *
     * @param 
     * @param a
     * @return
     */
    @SafeVarargs
    public static  ImmutableSet of(final E... a) {
        if (N.isNullOrEmpty(a)) {
            return empty();
        } else if (a.length == 1) {
            return new ImmutableSet<>(N.asSet(a[0]));
        } else {
            return new ImmutableSet<>(N.asSet(N.clone(a)));
        }
    }

    /**
     *
     * @param 
     * @param set
     * @return
     */
    public static  ImmutableSet copyOf(final Collection set) {
        if (N.isNullOrEmpty(set)) {
            return empty();
        }

        return new ImmutableSet<>((set instanceof LinkedHashSet || set instanceof SortedSet) ? N.newLinkedHashSet(set) : N.newHashSet(set));
    }

    /**
     *
     * @param 
     * @param set
     * @return an {@code ImmutableSet} backed by the specified {@code set}
     * @deprecated the ImmutableSet may be modified through the specified {@code set}
     */
    @Deprecated
    public static  ImmutableSet wrap(final Set set) {
        if (set == null) {
            return empty();
        } else if (set instanceof ImmutableSet) {
            return (ImmutableSet) set;
        }

        return new ImmutableSet<>(set);
    }

    /**
     * 
     *
     * @param  
     * @param c 
     * @return 
     * @throws UnsupportedOperationException 
     * @deprecated throws {@code UnsupportedOperationException}
     */
    @Deprecated
    public static  ImmutableCollection wrap(final Collection c) throws UnsupportedOperationException {
        throw new UnsupportedOperationException();
    }

    /**
     * 
     *
     * @param  
     * @return 
     */
    public static  Builder builder() {
        return new Builder<>();
    }

    public static final class Builder {
        private final Set ret = new HashSet<>();

        /**
         * 
         *
         * @param element 
         * @return 
         */
        public Builder add(final E element) {
            ret.add(element);

            return this;
        }

        /**
         * 
         *
         * @param elements 
         * @return 
         */
        public Builder add(final E... elements) {
            if (N.notNullOrEmpty(elements)) {
                ret.addAll(Arrays.asList(elements));
            }

            return this;
        }

        /**
         * 
         *
         * @param c 
         * @return 
         */
        public Builder addAll(final Collection c) {
            if (N.notNullOrEmpty(c)) {
                ret.addAll(c);
            }

            return this;
        }

        /**
         * 
         *
         * @param iter 
         * @return 
         */
        public Builder addAll(final Iterator iter) {
            if (iter != null) {
                while (iter.hasNext()) {
                    ret.add(iter.next());
                }
            }

            return this;
        }

        /**
         * 
         *
         * @return 
         */
        public ImmutableSet build() {
            return new ImmutableSet<>(ret);
        }
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy