Package com.mongodb

Class MongoNamespace

java.lang.Object

com.mongodb.MongoNamespace

@Immutable
public final class MongoNamespace
extends java.lang.Object

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

Since:

3.0

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	COMMAND_COLLECTION_NAME

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static void	checkCollectionNameValidity(java.lang.String collectionName)	Check the validity of the given collection name.
static void	checkDatabaseNameValidity(java.lang.String databaseName)	Check the validity of the given database name.
boolean	equals(java.lang.Object o)
java.lang.String	getCollectionName()	Gets the collection name.
java.lang.String	getDatabaseName()	Gets the database name.
java.lang.String	getFullName()	Gets the full name, which is the database name and the collection name, separated by a period.
int	hashCode()
java.lang.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 Detail

COMMAND_COLLECTION_NAME

public static final java.lang.String COMMAND_COLLECTION_NAME

See Also:

Constant Field Values

Constructor Detail

MongoNamespace

public MongoNamespace(java.lang.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")
                      java.lang.String databaseName,
                      @BsonProperty("coll")
                      java.lang.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 Detail

checkDatabaseNameValidity

public static void checkDatabaseNameValidity(java.lang.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:

java.lang.IllegalArgumentException - if the database name is invalid

Since:

3.4

MongoDB documentation

Naming Restrictions

checkCollectionNameValidity

public static void checkCollectionNameValidity(java.lang.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:

java.lang.IllegalArgumentException - if the collection name is invalid

Since:

3.4

MongoDB documentation

Naming Restrictions

getDatabaseName

@BsonProperty("db")
public java.lang.String getDatabaseName()

Gets the database name.

Returns:

the database name

getCollectionName

@BsonProperty("coll")
public java.lang.String getCollectionName()

Gets the collection name.

Returns:

the collection name

getFullName

public java.lang.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(java.lang.Object o)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

string representation of the namespace.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object