org.apache.ratis.util

Class OpenCloseState

java.lang.Object

org.apache.ratis.util.OpenCloseState

public class OpenCloseState
extends Object

The state of objects that can be unopened, opened, closed or exception.

Constructor Summary

Constructors

Constructor and Description
OpenCloseState(String name)

Method Summary

Modifier and Type	Method and Description
void	assertOpen() Assert this is open.
boolean	close() Transit to close state.
Throwable	getThrowable()
boolean	isClosed()
boolean	isOpened()
boolean	isUnopened()
void	open() Transit to open state.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenCloseState

public OpenCloseState(String name)

Method Detail

assertOpen

public void assertOpen()

Assert this is open.

isUnopened

public boolean isUnopened()

isOpened

public boolean isOpened()

isClosed

public boolean isClosed()

getThrowable

public Throwable getThrowable()

open

public void open()
          throws IOException

Transit to open state. The method is NOT idempotent.

Throws:

IOException

close

public boolean close()
              throws IOException

Transit to close state. The method is idempotent.

Returns:

true if the state is transited to close as a result of the invocation of this method. Otherwise, return false since it is already closed.

Throws:

IOException - if the current state is not allowed to transit to close.

toString

public String toString()

Overrides:

toString in class Object