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.util.counter;
18  
19  /***
20   * A Counter Manager that accepts a config to create counters. Creates counter's
21   * based on {@link CounterConfig}. This manages the lifycycle of a counter
22   * 
23   * @author <a href="mailto:asanoujam@terracottatech.com">Abhishek Sanoujam</a>
24   * @since 1.7
25   * 
26   */
27  public interface CounterManager {
28      /***
29       * Creates a Counter based on tha passed config
30       * 
31       * @param config
32       * @return The counter created and managed by this CounterManager
33       */
34      Counter createCounter(CounterConfig config);
35  
36      /***
37       * Shuts down this counter manager
38       */
39      void shutdown();
40  
41      /***
42       * Shuts down the counter
43       * 
44       * @param counter
45       */
46      void shutdownCounter(Counter counter);
47  
48  }