com.mongodb.client.model

Enum BucketGranularity

java.lang.Object

java.lang.Enum<BucketGranularity>

com.mongodb.client.model.BucketGranularity

All Implemented Interfaces:

Serializable, Comparable<BucketGranularity>

public enum BucketGranularity
extends Enum<BucketGranularity>

Granularity values for automatic bucketing.

Since:

3.4

See Also:

Preferred numbers

MongoDB documentation

$bucketAuto

Since server release

3.4

Enum Constant Summary

Enum Constants

Enum Constant and Description
E12
E192
E24
E48
E6
E96
POWERSOF2
R10
R20
R40
R5
R80
SERIES_125

Method Summary

Modifier and Type	Method and Description
static BucketGranularity	fromString(String value) Tries find the enum instance for the given value
String	getValue() Returns the display as defined in the preferred number article
static BucketGranularity	valueOf(String name) Returns the enum constant of this type with the specified name.
static BucketGranularity[]	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

R5

public static final BucketGranularity R5

R10

public static final BucketGranularity R10

R20

public static final BucketGranularity R20

R40

public static final BucketGranularity R40

R80

public static final BucketGranularity R80

SERIES_125

public static final BucketGranularity SERIES_125

E6

public static final BucketGranularity E6

E12

public static final BucketGranularity E12

E24

public static final BucketGranularity E24

E48

public static final BucketGranularity E48

E96

public static final BucketGranularity E96

E192

public static final BucketGranularity E192

POWERSOF2

public static final BucketGranularity POWERSOF2

Method Detail

values

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

Returns:

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

valueOf

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

fromString

public static BucketGranularity fromString(String value)

Tries find the enum instance for the given value

Parameters:

value - the value to search for

Returns:

the enum instance

getValue

public String getValue()

Returns the display as defined in the preferred number article

Returns:

the display name