org.apache.qpid.client

Class Closeable

java.lang.Object

org.apache.qpid.client.Closeable

Direct Known Subclasses:

AMQConnection, AMQSession, BasicMessageConsumer, BasicMessageProducer

public abstract class Closeable
extends Object

Captures the 'closed' state of an object, that is initially open, can be tested to see if it is closed, and provides a 'close' method to close it.

TODO Might be better to make this an interface. This whole class doesn't really encapsulate a terribly neat piece of re-usable functionality. A simple interface defining a close method would suffice.

TODO The convenience method checkNotClosed() is not that helpfull, what if the caller wants to do something other than throw an exception? It doesn't really represent a very usefull re-usable piece of code. Consider inlining it and dropping the method.

Constructor Summary

Constructors

Constructor and Description
Closeable()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkNotClosed() Checks if this is closed, and raises a JMSException if it is.
abstract void	close() Closes this object.
boolean	isClosed() Checks if this is closed.
boolean	isClosing() Checks if this is closing.
void	resetClosedFlag()
protected boolean	setClosed()
protected void	setClosing(boolean closing)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Closeable

public Closeable()

Method Detail

checkNotClosed

protected void checkNotClosed()
                       throws javax.jms.JMSException

Checks if this is closed, and raises a JMSException if it is.

Throws:

javax.jms.JMSException - If this is closed.

isClosed

public boolean isClosed()

Checks if this is closed.

Returns:

true if this is closed, false otherwise.

isClosing

public boolean isClosing()

Checks if this is closing.

Returns:

true if we are closing, false otherwise.

resetClosedFlag

public void resetClosedFlag()

setClosed

protected boolean setClosed()

setClosing

protected void setClosing(boolean closing)

close

public abstract void close()
                    throws javax.jms.JMSException

Closes this object.

Throws:

javax.jms.JMSException - If this cannot be closed for any reason.