View Javadoc
1   package org.apache.commons.jcs3.engine.behavior;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  /**
23   * This interface is required of all shutdown observers.  These observers
24   * can observer ShutdownObservable objects.  The CacheManager is the primary
25   * observable that this is intended for.
26   * <p>
27   * Most shutdown operations will occur outside this framework for now.  The initial
28   * goal is to allow background threads that are not reachable through any reference
29   * that the cache manager maintains to be killed on shutdown.
30   * </p>
31   */
32  public interface IShutdownObserver
33  {
34      /**
35       * Tells the observer that the observable has received a shutdown command.
36       *
37       */
38      void shutdown();
39  }