KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > activemq > Closeable


1 /**
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one or more
4  * contributor license agreements. See the NOTICE file distributed with
5  * this work for additional information regarding copyright ownership.
6  * The ASF licenses this file to You under the Apache License, Version 2.0
7  * (the "License"); you may not use this file except in compliance with
8  * the License. You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18 package org.apache.activemq;
19
20 import javax.jms.JMSException JavaDoc;
21
22 /**
23  * Provides a uniform interface that can be used to close all the JMS obejcts
24  * that provide a close() method. Useful for when you want to collect
25  * a heterogeous set of JMS object in a collection to be closed at a later time.
26  *
27  * @version $Revision: 1.2 $
28  */
29 public interface Closeable {
30     
31     /**
32      * Closes a JMS object.
33      * <P>
34      * Many JMS objects are closeable such as Connections, Sessions, Consumers and Producers.
35      *
36      * @throws JMSException if the JMS provider fails to close the object due to
37      * some internal error.
38      */
39     public void close() throws JMSException JavaDoc;
40 }
41
Popular Tags