rapture.mongodb

Enum MongoDBFactory

java.lang.Object

java.lang.Enum<MongoDBFactory>

rapture.mongodb.MongoDBFactory

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MongoDBFactory>

public enum MongoDBFactory
extends java.lang.Enum<MongoDBFactory>

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Modifier and Type	Method and Description
boolean	canConnect()
static com.mongodb.client.MongoCollection<org.bson.Document>	getCollection(java.lang.String instanceName, java.lang.String name)
static com.mongodb.client.MongoDatabase	getDatabase(java.lang.String instanceName) get the database or throw a RaptureException -- never returns null
static com.mongodb.DB	getDB(java.lang.String instanceName) Deprecated. Use getMongoDatabase This is still needed because GridFS constructor requires a DB not a MongoDatabase. Once GridFS is updated (Mongo 3.1) this can be eliminated.
static int	getRetryCount()
static void	setRetryCount(int retryCount)
static MongoDBFactory	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MongoDBFactory[]	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

INSTANCE

public static final MongoDBFactory INSTANCE

Method Detail

values

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

Returns:

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

valueOf

public static MongoDBFactory valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getRetryCount

public static int getRetryCount()

setRetryCount

public static void setRetryCount(int retryCount)

canConnect

public boolean canConnect()

getDB

@Deprecated
public static com.mongodb.DB getDB(java.lang.String instanceName)

Deprecated. Use getMongoDatabase This is still needed because GridFS constructor requires a DB not a MongoDatabase. Once GridFS is updated (Mongo 3.1) this can be eliminated.

getCollection

public static com.mongodb.client.MongoCollection<org.bson.Document> getCollection(java.lang.String instanceName,
                                                                                  java.lang.String name)

getDatabase

public static com.mongodb.client.MongoDatabase getDatabase(java.lang.String instanceName)

get the database or throw a RaptureException -- never returns null