net.dv8tion.jda.api.utils.cache.SortedSnowflakeCacheView Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of JDA Show documentation

Java wrapper for the popular chat & VOIP service: Discord https://discord.com

There is a newer version: 5.1.0

/*
 * Copyright 2015 Austin Keener, Michael Ritter, Florian Spieß, and the JDA contributors
 *
 * 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 net.dv8tion.jda.api.utils.cache;

import net.dv8tion.jda.api.entities.ISnowflake;

import javax.annotation.Nonnull;
import java.util.NavigableSet;
import java.util.function.Consumer;
import java.util.stream.Stream;

/**
 * Specialized {@link CacheView} for entities that occur in a specified order.
 * 
In this specialization {@link #forEach(Consumer)} will copy the underlying data store
 * in order to preserve order on iterations, use {@link #forEachUnordered(Consumer)} to avoid this overhead.
 *
 * @param 
 *        The entity type
 *
 * @see   CacheView CacheView for details on Efficient Memory Usage
 */
public interface SortedSnowflakeCacheView & ISnowflake> extends SnowflakeCacheView
{
    /**
     * Behavior similar to {@link CacheView#forEach(Consumer)} but does not preserve order.
     * 
This will not copy the data store as sorting is not needed.
     *
     * @param  action
     *         The action to perform
     *
     * @throws NullPointerException
     *         If provided with null
     *
     * @since  4.0.0
     */
    void forEachUnordered(@Nonnull final Consumer action);

    @Nonnull
    @Override
    NavigableSet asSet();

    /**
     * Behavior similar to {@link CacheView#stream()} which does not preserve order.
     *
     * @return Stream of the contained elements
     *
     * @since  4.0.0
     */
    @Nonnull
    Stream streamUnordered();

    /**
     * Behavior similar to {@link CacheView#parallelStream()} which does not preserve order.
     *
     * @return (Parallel) Stream of contained elements
     *
     * @since  4.0.0
     */
    @Nonnull
    Stream parallelStreamUnordered();
}