Package com.mongodb.event

Enum ConnectionRemovedEvent.Reason

java.lang.Object

java.lang.Enum<ConnectionRemovedEvent.Reason>

com.mongodb.event.ConnectionRemovedEvent.Reason

All Implemented Interfaces:

Serializable, Comparable<ConnectionRemovedEvent.Reason>

Enclosing class:

ConnectionRemovedEvent

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

An enumeration of the reasons a connection could be closed

Since:

3.11

Enum Constant Summary

Enum Constants

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

Method Summary

Modifier and Type	Method	Description
static ConnectionRemovedEvent.Reason	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ConnectionRemovedEvent.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

UNKNOWN

public static final ConnectionRemovedEvent.Reason UNKNOWN

Reason unknown

STALE

public static final ConnectionRemovedEvent.Reason STALE

The pool became stale because the pool has been cleared

MAX_IDLE_TIME_EXCEEDED

public static final ConnectionRemovedEvent.Reason MAX_IDLE_TIME_EXCEEDED

The connection became stale by being idle for too long

MAX_LIFE_TIME_EXCEEDED

public static final ConnectionRemovedEvent.Reason MAX_LIFE_TIME_EXCEEDED

The connection became stale by being open for too long

ERROR

public static final ConnectionRemovedEvent.Reason ERROR

The connection experienced an error, making it no longer valid

POOL_CLOSED

public static final ConnectionRemovedEvent.Reason POOL_CLOSED

The pool was closed, making the connection no longer valid

Method Detail

values

public static ConnectionRemovedEvent.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 (ConnectionRemovedEvent.Reason c : ConnectionRemovedEvent.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 ConnectionRemovedEvent.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