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

Show more of this group Show more artifacts with this name
Show all versions of abacus-common Show documentation
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
/*
 * Copyright (c) 2017, 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.Collection;
import java.util.Set;
import java.util.function.Supplier;

import com.landawn.abacus.util.Fn.Suppliers;

/**
 *
 * @author Haiyang Li
 * @param 
 * @since 0.9
 */
@com.landawn.abacus.annotation.Immutable
abstract class ImmutableIterator implements java.util.Iterator, Immutable {

    /**
     * 
     *
     * @throws UnsupportedOperationException 
     * @deprecated - UnsupportedOperationException
     */
    @Deprecated
    @Override
    public void remove() throws UnsupportedOperationException {
        throw new UnsupportedOperationException();
    }

    /**
     * 
     *
     * @return 
     */
    public Set toSet() {
        return toCollection(Suppliers. ofSet());
    }

    /**
     *
     * @param 
     * @param supplier
     * @return
     */
    public > C toCollection(final Supplier supplier) {
        final C c = supplier.get();

        while (hasNext()) {
            c.add(next());
        }

        return c;
    }

    /**
     * 
     *
     * @return 
     */
    @SuppressWarnings("deprecation")
    public ImmutableList toImmutableList() {
        return ImmutableList.wrap(toCollection(Suppliers. ofList()));
    }

    /**
     * 
     *
     * @return 
     */
    @SuppressWarnings("deprecation")
    public ImmutableSet toImmutableSet() {
        return ImmutableSet.wrap(toSet());
    }

    // Not efficient for primitive iterators because function is not for primitives.
    //    /**
    //     *
    //     * @param  the key type
    //     * @param 
    //     * @param keyMapper
    //     * @return
    //     * @throws E the e
    //     */
    //    public  Map toMap(final Try.Function keyMapper) throws E {
    //        return Iterators.toMap(this, keyMapper);
    //    }
    //
    //    /**
    //     *
    //     * @param  the key type
    //     * @param  the value type
    //     * @param 
    //     * @param 
    //     * @param keyMapper
    //     * @param valueExtractor
    //     * @return
    //     * @throws E the e
    //     * @throws E2 the e2
    //     */
    //    public  Map toMap(final Try.Function keyMapper,
    //            final Try.Function valueExtractor) throws E, E2 {
    //        return Iterators.toMap(this, keyMapper, valueExtractor);
    //    }
    //
    //    /**
    //     *
    //     * @param  the key type
    //     * @param  the value type
    //     * @param 
    //     * @param 
    //     * @param 
    //     * @param keyMapper
    //     * @param valueExtractor
    //     * @param mapSupplier
    //     * @return
    //     * @throws E the e
    //     * @throws E2 the e2
    //     */
    //    public , E extends Exception, E2 extends Exception> M toMap(final Try.Function keyMapper,
    //            final Try.Function valueExtractor, final Supplier mapSupplier) throws E, E2 {
    //        return Iterators.toMap(this, keyMapper, valueExtractor, mapSupplier);
    //    }
    //
    //    /**
    //     *
    //     * @param  the key type
    //     * @param 
    //     * @param keyMapper
    //     * @return
    //     * @throws E the e
    //     */
    //    public  ImmutableMap toImmutableMap(final Try.Function keyMapper) throws E {
    //        return ImmutableMap.wrap(toMap(keyMapper));
    //    }
    //
    //    /**
    //     *
    //     * @param  the key type
    //     * @param  the value type
    //     * @param 
    //     * @param 
    //     * @param keyMapper
    //     * @param valueExtractor
    //     * @return
    //     * @throws E the e
    //     * @throws E2 the e2
    //     */
    //    public  ImmutableMap toImmutableMap(final Try.Function keyMapper,
    //            final Try.Function valueExtractor) throws E, E2 {
    //        return ImmutableMap.wrap(toMap(keyMapper, valueExtractor));
    //    }
    //
    //    /**
    //     *
    //     * @param  the key type
    //     * @param  the value type
    //     * @param 
    //     * @param 
    //     * @param 
    //     * @param keyMapper
    //     * @param valueExtractor
    //     * @param mapSupplier
    //     * @return
    //     * @throws E the e
    //     * @throws E2 the e2
    //     */
    //    public , E extends Exception, E2 extends Exception> ImmutableMap toImmutableMap(
    //            final Try.Function keyMapper, final Try.Function valueExtractor,
    //            final Supplier mapSupplier) throws E, E2 {
    //        return ImmutableMap.wrap(toMap(keyMapper, valueExtractor, mapSupplier));
    //    }
}