Package com.mongodb

Class MongoNamespace

java.lang.Object

com.mongodb.MongoNamespace

@Immutable
public final class MongoNamespace
extends Object

A MongoDB namespace, which includes a database name and collection name.

Since:

3.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMMAND_COLLECTION_NAME	The collection name in which to execute a command.

Constructor Summary

Constructors

Constructor	Description
MongoNamespace(String fullName)	Construct an instance for the given full name.
MongoNamespace(String databaseName, String collectionName)	Construct an instance from the given database name and collection name.

Method Summary

Modifier and Type	Method	Description
static void	checkCollectionNameValidity(String collectionName)	Check the validity of the given collection name.
static void	checkDatabaseNameValidity(String databaseName)	Check the validity of the given database name.
boolean	equals(Object o)
String	getCollectionName()	Gets the collection name.
String	getDatabaseName()	Gets the database name.
String	getFullName()	Gets the full name, which is the database name and the collection name, separated by a period.
int	hashCode()
String	toString()	Returns the standard MongoDB representation of a namespace, which is <database>.<collection>.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

COMMAND_COLLECTION_NAME

public static final String COMMAND_COLLECTION_NAME

The collection name in which to execute a command.

See Also:

• Constant Field Values

Constructor Details

MongoNamespace

public MongoNamespace(String fullName)

Construct an instance for the given full name. The database name is the string preceding the first "." character.

Parameters:

fullName - the non-null full namespace

See Also:

• checkDatabaseNameValidity(String)
• checkCollectionNameValidity(String)

MongoNamespace

public MongoNamespace(@BsonProperty("db")
 String databaseName,
 @BsonProperty("coll")
 String collectionName)

Construct an instance from the given database name and collection name.

Parameters:

databaseName - the valid database name

collectionName - the valid collection name

See Also:

• checkDatabaseNameValidity(String)
• checkCollectionNameValidity(String)

Method Details

checkDatabaseNameValidity

public static void checkDatabaseNameValidity(String databaseName)

Check the validity of the given database name. A valid database name is non-null, non-empty, and does not contain any of the following characters: '\0', '/', '\\', ' ', '"', '.'. The server may impose additional restrictions on database names.

Parameters:

databaseName - the database name

Throws:

IllegalArgumentException - if the database name is invalid

Since:

3.4

MongoDB documentation

Naming Restrictions

checkCollectionNameValidity

public static void checkCollectionNameValidity(String collectionName)

Check the validity of the given collection name. A valid collection name is non-null and non-empty. The server may impose additional restrictions on collection names.

Parameters:

collectionName - the collection name

Throws:

IllegalArgumentException - if the collection name is invalid

Since:

3.4

MongoDB documentation

Naming Restrictions

getDatabaseName

@BsonProperty("db")
public String getDatabaseName()

Gets the database name.

Returns:

the database name

getCollectionName

@BsonProperty("coll")
public String getCollectionName()

Gets the collection name.

Returns:

the collection name

getFullName

public String getFullName()

Gets the full name, which is the database name and the collection name, separated by a period.

Returns:

the full name

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Returns the standard MongoDB representation of a namespace, which is <database>.<collection>.

Overrides:

toString in class Object

Returns:

string representation of the namespace.

hashCode

public int hashCode()

Overrides:

hashCode in class Object