Source code: org/activemq/Closeable.java
1 /**
2 *
3 * Copyright 2004 Protique Ltd
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *
17 **/
18 package org.activemq;
19
20 import javax.jms.JMSException;
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.1.1.1 $
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;
40 }