View Javadoc

1   /*
2      Copyright 2010 Ramon Servadei
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  package mirrormap.lifecycle;
17  
18  /**
19   * An object that can be destroyed.
20   * 
21   * @author Ramon Servadei
22   */
23  public interface IDestroyable
24  {
25      /**
26       * This is called when the object is being removed from application use.
27       * This releases all system resources and performs clean up prior to the
28       * object becoming redundant. <u>This operation is idempotent.</u>
29       * <p>
30       * This method must not throw a {@link RuntimeException}.
31       */
32      void destroy();
33  }