Package net.dv8tion.jda.internal.utils.cache

Class UnifiedChannelCacheView<C extends Channel>

java.lang.Object
net.dv8tion.jda.internal.utils.cache.UnifiedChannelCacheView<C>
All Implemented Interfaces:
Iterable<C>, CacheView<C>, ChannelCacheView<C>, SnowflakeCacheView<C>
public class UnifiedChannelCacheView<C extends Channel> extends Object implements ChannelCacheView<C>

  • Constructor Details

  • Method Details

    • forEach

      public void forEach(Consumer<? super C> action)
      Specified by:
      forEach in interface Iterable<C extends Channel>

    • asList

      @Nonnull public List<C> asList()
      Description copied from interface: CacheView
      Creates an immutable snapshot of the current cache state.
      This will copy all elements contained in this cache into a list.
      This will be sorted for a SortedSnowflakeCacheView.
      Specified by:
      asList in interface CacheView<C extends Channel>
      Returns:
      Immutable list of cached elements

    • asSet

      @Nonnull public Set<C> asSet()
      Description copied from interface: CacheView
      Creates an immutable snapshot of the current cache state.
      This will copy all elements contained in this cache into a set.
      Specified by:
      asSet in interface CacheView<C extends Channel>
      Returns:
      Immutable set of cached elements

    • lockedIterator

      @Nonnull public ClosableIterator<C> lockedIterator()
      Description copied from interface: CacheView
      Returns an iterator with direct access to the underlying data store. This iterator does not support removing elements.
      After usage this iterator should be closed to allow modifications by the library internals.

      Note: Order is not preserved in this iterator to be more efficient, if order is desired use Iterable.iterator() instead!

      Specified by:
      lockedIterator in interface CacheView<C extends Channel>
      Returns:
      ClosableIterator holding a read-lock on the data structure.

    • size

      public long size()
      Description copied from interface: CacheView
      The current size of this cache
      This is a long as it may be a projected view of multiple caches (See CacheView.all(java.util.function.Supplier))

      This is more efficient than creating a list or set snapshot first as it checks the size of the internal cache directly.

      Specified by:
      size in interface CacheView<C extends Channel>
      Returns:
      The current size of this cache

    • isEmpty

      public boolean isEmpty()
      Description copied from interface: CacheView
      Whether the cache is empty

      This is more efficient than creating a list or set snapshot first as it checks the size of the internal cache directly.
      On a projected cache view this will simply look through all projected views and return false the moment it finds one that is not empty.

      Specified by:
      isEmpty in interface CacheView<C extends Channel>
      Returns:
      True, if this cache is currently empty

    • getElementsByName

      @Nonnull public List<C> getElementsByName(@Nonnull String name, boolean ignoreCase)
      Description copied from interface: CacheView
      Creates an immutable list of all elements matching the given name.
      For a MemberCacheView this will check the Effective Name of the cached members.
      Specified by:
      getElementsByName in interface CacheView<C extends Channel>
      Parameters:
      name - The name to check
      ignoreCase - Whether to ignore case when comparing names
      Returns:
      Immutable list of elements with the given name

    • stream

      @Nonnull public Stream<C> stream()
      Description copied from interface: CacheView
      Creates a Stream of all cached elements.
      This will be sorted for a SortedSnowflakeCacheView.
      Specified by:
      stream in interface CacheView<C extends Channel>
      Returns:
      Stream of elements

    • parallelStream

      @Nonnull public Stream<C> parallelStream()
      Description copied from interface: CacheView
      Creates a parallel Stream of all cached elements.
      This will be sorted for a SortedSnowflakeCacheView.
      Specified by:
      parallelStream in interface CacheView<C extends Channel>
      Returns:
      Parallel Stream of elements

    • ofType

      @Nonnull public <T extends C> ChannelCacheView<T> ofType(@Nonnull Class<T> type)
      Description copied from interface: ChannelCacheView
      Creates a decorator around this cache, filtered to only provide access to the given type.
      Specified by:
      ofType in interface ChannelCacheView<C extends Channel>
      Type Parameters:
      T - The type parameter
      Parameters:
      type - The type class (Like TextChannel.class)
      Returns:
      The filtered cache view

    • getElementById

      @Nullable public C getElementById(@Nonnull ChannelType type, long id)
      Description copied from interface: ChannelCacheView
      Retrieves the entity represented by the provided ID.
      Specified by:
      getElementById in interface ChannelCacheView<C extends Channel>
      Parameters:
      type - The expected ChannelType
      id - The ID of the entity
      Returns:
      Possibly-null entity for the specified ID, null if the expected type is different from the actual type

    • getElementById

      @Nullable public C getElementById(long id)
      Description copied from interface: SnowflakeCacheView
      Retrieves the entity represented by the provided ID.
      Specified by:
      getElementById in interface SnowflakeCacheView<C extends Channel>
      Parameters:
      id - The ID of the entity
      Returns:
      Possibly-null entity for the specified ID

    • iterator

      @Nonnull public Iterator<C> iterator()
      Specified by:
      iterator in interface Iterable<C extends Channel>