Package com.mewna.catnip.cache.view

Interface NamedCacheView<T>

Type Parameters:

T - Type of the entity held by this cache.

All Superinterfaces:

CacheView<T>, Iterable<T>

All Known Subinterfaces:

MutableNamedCacheView<T>

All Known Implementing Classes:

CompositeNamedCacheView, DefaultNamedCacheView, NoopCacheView

public interface NamedCacheView<T>
extends CacheView<T>

A CacheView that provides utilities for finding elements based on their name.

Since:

12/15/18

Author:

natanbc

Method Summary

Modifier and Type	Method	Description
default Collection<T>	findByName(String name)	Finds all entities with a name equal to the provided value.
Collection<T>	findByName(String name, boolean ignoreCase)	Finds all entities with a name equal to the provided value.
<C extends Collection<T>> C	findByName(String name, boolean ignoreCase, Supplier<C> supplier)	Finds all entities with a name equal to the provided value.
default <C extends Collection<T>> C	findByName(String name, Supplier<C> supplier)	Finds all entities with a name equal to the provided value.
default Collection<T>	findByNameContains(String name)	Finds all entities whose name contains the provided value.
Collection<T>	findByNameContains(String name, boolean ignoreCase)	Finds all entities whose name contains the provided value.
<C extends Collection<T>> C	findByNameContains(String name, boolean ignoreCase, Supplier<C> supplier)	Finds all entities whose name contains the provided value.
default <C extends Collection<T>> C	findByNameContains(String name, Supplier<C> supplier)	Finds all entities whose name contains the provided value.
default Collection<T>	findByNameEndsWith(String name)	Finds all entities whose name ends with the provided value.
Collection<T>	findByNameEndsWith(String name, boolean ignoreCase)	Finds all entities whose name ends with the provided value.
<C extends Collection<T>> C	findByNameEndsWith(String name, boolean ignoreCase, Supplier<C> supplier)	Finds all entities whose name ends with the provided value.
default <C extends Collection<T>> C	findByNameEndsWith(String name, Supplier<C> supplier)	Finds all entities whose name ends with the provided value.
default Collection<T>	findByNameStartsWith(String name)	Finds all entities whose name starts with the provided value.
Collection<T>	findByNameStartsWith(String name, boolean ignoreCase)	Finds all entities whose name starts with the provided value.
<C extends Collection<T>> C	findByNameStartsWith(String name, boolean ignoreCase, Supplier<C> supplier)	Finds all entities whose name starts with the provided value.
default <C extends Collection<T>> C	findByNameStartsWith(String name, Supplier<C> supplier)	Finds all entities whose name starts with the provided value.

Methods inherited from interface com.mewna.catnip.cache.view.CacheView

allMatch, anyMatch, collect, collect, count, find, find, findAny, forEach, getById, getById, isEmpty, keys, max, min, noneMatch, reduce, reduce, reduce, size, snapshot, snapshot, spliterator, stream, values

Methods inherited from interface java.lang.Iterable

iterator

Method Details

findByName

@Nonnull
Collection<T> findByName(@Nonnull
 String name,
 boolean ignoreCase)

Finds all entities with a name equal to the provided value.

Parameters:

name - Name to search for.

ignoreCase - Ignore casing differences between the entity names and the provided name.

Returns:

All elements that have a name equal to the provided.

See Also:

• String.equals(Object)
• String.equalsIgnoreCase(String)

findByName

@Nonnull
default Collection<T> findByName(@Nonnull
 String name)

Finds all entities with a name equal to the provided value.

Parameters:

name - Name to search for.

Returns:

All elements that have a name equal to the provided.

See Also:

• String.equals(Object)

findByName

@Nonnull
<C extends Collection<T>> C findByName(@Nonnull
 String name,
 boolean ignoreCase,
 @Nonnull
 Supplier<C> supplier)

Finds all entities with a name equal to the provided value.

Parameters:

name - Name to search for.

ignoreCase - Ignore casing differences between the entity names and the provided name.

supplier - Supplier for the collection to add the elements to. The returned collection must be mutable.

Returns:

The collection returned by supplier, after adding the matching elements. May be empty.

See Also:

• String.equals(Object)
• String.equalsIgnoreCase(String)

findByName

@Nonnull
default <C extends Collection<T>> C findByName(@Nonnull
 String name,
 @Nonnull
 Supplier<C> supplier)

Finds all entities with a name equal to the provided value.

Parameters:

name - Name to search for.

supplier - Supplier for the collection to add the elements to. The returned collection must be mutable.

Returns:

The collection returned by supplier, after adding the matching elements. May be empty.

See Also:

• String.equals(Object)

findByNameContains

@Nonnull
Collection<T> findByNameContains(@Nonnull
 String name,
 boolean ignoreCase)

Finds all entities whose name contains the provided value.

Parameters:

name - Name to search for.

ignoreCase - Ignore casing differences between the entity names and the provided name.

Returns:

All elements that have a name containing the provided.

See Also:

• String.contains(CharSequence)
• Utils.containsIgnoreCase(String, String)

findByNameContains

@Nonnull
default Collection<T> findByNameContains(@Nonnull
 String name)

Finds all entities whose name contains the provided value.

Parameters:

name - Name to search for.

Returns:

All elements that have a name containing the provided.

See Also:

• String.contains(CharSequence)

findByNameContains

@Nonnull
<C extends Collection<T>> C findByNameContains(@Nonnull
 String name,
 boolean ignoreCase,
 @Nonnull
 Supplier<C> supplier)

Finds all entities whose name contains the provided value.

Parameters:

name - Name to search for.

ignoreCase - Ignore casing differences between the entity names and the provided name.

supplier - Supplier for the collection to add the elements to. The returned collection must be mutable.

Returns:

The collection returned by supplier, after adding the matching elements. May be empty.

See Also:

• String.contains(CharSequence)
• Utils.containsIgnoreCase(String, String)

findByNameContains

@Nonnull
default <C extends Collection<T>> C findByNameContains(@Nonnull
 String name,
 @Nonnull
 Supplier<C> supplier)

Finds all entities whose name contains the provided value.

Parameters:

name - Name to search for.

supplier - Supplier for the collection to add the elements to. The returned collection must be mutable.

Returns:

The collection returned by supplier, after adding the matching elements. May be empty.

See Also:

• String.contains(CharSequence)

findByNameStartsWith

@Nonnull
Collection<T> findByNameStartsWith(@Nonnull
 String name,
 boolean ignoreCase)

Finds all entities whose name starts with the provided value.

Parameters:

name - Name to search for.

ignoreCase - Ignore casing differences between the entity names and the provided name.

Returns:

All elements that have a name starting with the provided.

See Also:

• String.startsWith(String)
• Utils.startsWithIgnoreCase(String, String)

findByNameStartsWith

@Nonnull
default Collection<T> findByNameStartsWith(@Nonnull
 String name)

Finds all entities whose name starts with the provided value.

Parameters:

name - Name to search for.

Returns:

All elements that have a name starting with the provided.

See Also:

• String.startsWith(String)

findByNameStartsWith

@Nonnull
<C extends Collection<T>> C findByNameStartsWith(@Nonnull
 String name,
 boolean ignoreCase,
 @Nonnull
 Supplier<C> supplier)

Finds all entities whose name starts with the provided value.

Parameters:

name - Name to search for.

ignoreCase - Ignore casing differences between the entity names and the provided name.

supplier - Supplier for the collection to add the elements to. The returned collection must be mutable.

Returns:

The collection returned by supplier, after adding the matching elements. May be empty.

See Also:

• String.startsWith(String)
• Utils.startsWithIgnoreCase(String, String)

findByNameStartsWith

@Nonnull
default <C extends Collection<T>> C findByNameStartsWith(@Nonnull
 String name,
 @Nonnull
 Supplier<C> supplier)

Finds all entities whose name starts with the provided value.

Parameters:

name - Name to search for.

supplier - Supplier for the collection to add the elements to. The returned collection must be mutable.

Returns:

The collection returned by supplier, after adding the matching elements. May be empty.

See Also:

• String.startsWith(String)

findByNameEndsWith

@Nonnull
Collection<T> findByNameEndsWith(@Nonnull
 String name,
 boolean ignoreCase)

Finds all entities whose name ends with the provided value.

Parameters:

name - Name to search for.

ignoreCase - Ignore casing differences between the entity names and the provided name.

Returns:

All elements that have a name ending with the provided.

See Also:

• String.endsWith(String)
• Utils.endsWithIgnoreCase(String, String)

findByNameEndsWith

@Nonnull
default Collection<T> findByNameEndsWith(@Nonnull
 String name)

Finds all entities whose name ends with the provided value.

Parameters:

name - Name to search for.

Returns:

All elements that have a name ending with the provided.

See Also:

• String.endsWith(String)

findByNameEndsWith

@Nonnull
<C extends Collection<T>> C findByNameEndsWith(@Nonnull
 String name,
 boolean ignoreCase,
 @Nonnull
 Supplier<C> supplier)

Finds all entities whose name ends with the provided value.

Parameters:

name - Name to search for.

ignoreCase - Ignore casing differences between the entity names and the provided name.

supplier - Supplier for the collection to add the elements to. The returned collection must be mutable.

Returns:

The collection returned by supplier, after adding the matching elements. May be empty.

See Also:

• String.endsWith(String)
• Utils.endsWithIgnoreCase(String, String)

findByNameEndsWith

@Nonnull
default <C extends Collection<T>> C findByNameEndsWith(@Nonnull
 String name,
 @Nonnull
 Supplier<C> supplier)

Finds all entities whose name ends with the provided value.

Parameters:

name - Name to search for.

supplier - Supplier for the collection to add the elements to. The returned collection must be mutable.

Returns:

The collection returned by supplier, after adding the matching elements. May be empty.

See Also:

• String.endsWith(String)