com.tangosol.net.NamedCollection Maven / Gradle / Ivy

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

Oracle Coherence Community Edition

There is a newer version: 24.03

/*
 * Copyright (c) 2000, 2020, Oracle and/or its affiliates.
 *
 * Licensed under the Universal Permissive License v 1.0 as shown at
 * http://oss.oracle.com/licenses/upl.
 */
package com.tangosol.net;


/**
 * NamedCollection defines a common base interface for various named collection types.
 *
 * @author jk 2015.06.27
 * @since Coherence 14.1.1
 */
public interface NamedCollection
        extends Releasable
    {
    /**
     * Obtain the name of this NamedCollection.
     *
     * @return the name of this NamedCollection
     */
    public String getName();

    /**
     * Return the Service that this NamedCollection is a part of.
     *
     * @return the Service
     */
    public Service getService();

    /**
     * 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.
     */
    public void destroy();

    /**
     * The Option interface defines the root interface of all NamedCollection Options.
     */
    public interface Option
        {
        }
    }