Package com.mongodb

Enum ServerApiVersion

java.lang.Object

java.lang.Enum<ServerApiVersion>

com.mongodb.ServerApiVersion

All Implemented Interfaces:

Serializable, Comparable<ServerApiVersion>

public enum ServerApiVersion
extends Enum<ServerApiVersion>

The Server API version.

Since:

4.3

Enum Constant Summary

Enum Constants

Enum Constant	Description
V1	Server API version 1

Method Summary

Modifier and Type	Method	Description
static ServerApiVersion	findByValue(String value)	Gets the ServerApiVersion that corresponds to the given value.
String	getValue()	Gets the version as a string.
static ServerApiVersion	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ServerApiVersion[]	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

V1

public static final ServerApiVersion V1

Server API version 1

Method Detail

values

public static ServerApiVersion[] 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 (ServerApiVersion c : ServerApiVersion.values())
    System.out.println(c);

Returns:

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

valueOf

public static ServerApiVersion 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

getValue

public String getValue()

Gets the version as a string.

Returns:

the version string

findByValue

public static ServerApiVersion findByValue(String value)

Gets the ServerApiVersion that corresponds to the given value.

Parameters:

value - the String value of the desired server API version

Returns:

the corresponding ServerApiVersion

Throws:

MongoClientException - if no matching enumeration exists