Package com.mongodb.event

Enum ConnectionClosedEvent.Reason

java.lang.Object

java.lang.Enum<ConnectionClosedEvent.Reason>

com.mongodb.event.ConnectionClosedEvent.Reason

All Implemented Interfaces:

Serializable, Comparable<ConnectionClosedEvent.Reason>

Enclosing class:

ConnectionClosedEvent

public static enum ConnectionClosedEvent.Reason
extends Enum<ConnectionClosedEvent.Reason>

An enumeration of the reasons a connection could be closed

Enum Constant Summary

Enum Constants

Enum Constant	Description
ERROR	The connection experienced an error, making it no longer valid
IDLE	The connection became stale by being idle for too long
POOL_CLOSED	The pool was closed, making the connection no longer valid
STALE	The connection is no longer valid because the pool has been cleared

Method Summary

Modifier and Type	Method	Description
static ConnectionClosedEvent.Reason	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ConnectionClosedEvent.Reason[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

STALE

public static final ConnectionClosedEvent.Reason STALE

The connection is no longer valid because the pool has been cleared

IDLE

public static final ConnectionClosedEvent.Reason IDLE

The connection became stale by being idle for too long

ERROR

public static final ConnectionClosedEvent.Reason ERROR

The connection experienced an error, making it no longer valid

POOL_CLOSED

public static final ConnectionClosedEvent.Reason POOL_CLOSED

The pool was closed, making the connection no longer valid

Method Detail

values

public static ConnectionClosedEvent.Reason[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ConnectionClosedEvent.Reason c : ConnectionClosedEvent.Reason.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ConnectionClosedEvent.Reason valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null