NamedCollection (Oracle® Coherence Java API Reference)

All Superinterfaces:

AutoCloseable, Releasable

All Known Subinterfaces:

NamedCache<K,V>, NamedMap<K,V>, NamedTopic<V>, OptimisticNamedCache

All Known Implementing Classes:

BundlingNamedCache, ContinuousQueryCache, ConverterCollections.ConverterNamedCache, NearCache, ReadonlyNamedCache, VersionedNearCache, WrapperNamedCache
```
public interface NamedCollection
extends Releasable
```
NamedCollection defines a common base interface for various named collection types.

Since:

Coherence 14.1.1

Author:

jk 2015.06.27

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static interface NamedCollection.Option
The Option interface defines the root interface of all NamedCollection Options.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`void`	`destroy()`	Release and destroy this instance of NamedCollection.
`String`	`getName()`	Obtain the name of this NamedCollection.
`Service`	`getService()`	Return the Service that this NamedCollection is a part of.
`default boolean`	`isDestroyed()`	Specifies whether or not this NamedCollection has been destroyed.

Methods inherited from interface com.tangosol.net.Releasable
close, isActive, isReleased, release

- Method Detail
  - getName
```
String getName()
```
    Obtain the name of this NamedCollection.
    
    Returns:
    
    the name of this NamedCollection
  - getService
```
Service getService()
```
    Return the Service that this NamedCollection is a part of.
    
    Returns:
    
    the Service
  - destroy
```
void destroy()
```
    Release and destroy this instance of NamedCollection.
    Warning: This method is used to completely destroy the specified collection across the cluster. All references in the entire cluster to this collection will be invalidated, the collection data will be cleared, and all internal resources will be released.
  - isDestroyed
```
default boolean isDestroyed()
```
    Specifies whether or not this NamedCollection has been destroyed. Implementations must override this method to provide the necessary information.
    
    Returns:
    
    true if the NamedCollection has been destroyed; false otherwise