View Javadoc

1   /***
2    *  Copyright 2003-2010 Terracotta, Inc.
3    *
4    *  Licensed under the Apache License, Version 2.0 (the "License");
5    *  you may not use this file except in compliance with the License.
6    *  You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   *  Unless required by applicable law or agreed to in writing, software
11   *  distributed under the License is distributed on an "AS IS" BASIS,
12   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   *  See the License for the specific language governing permissions and
14   *  limitations under the License.
15   */
16  
17  package net.sf.ehcache;
18  
19  /***
20   * A <tt>Disposable</tt> is a resource that needs to release other resources when it is no longer needed.
21   * Resources registered with a CacheManager (or Cache), will have this method called whenever they are disposed themselves...
22   *
23   * @author Alex Snaps
24   * @since 2.5.0
25   */
26  public interface Disposable {
27  
28      /***
29       * Disposes the resource and releases any system resources associated
30       * with it. If the resource was already disposed of, this has no effect
31       */
32      void dispose();
33  }