Class ReferenceResolver.ReferenceCollection

java.lang.Object

org.springframework.data.mongodb.core.convert.ReferenceResolver.ReferenceCollection

Enclosing interface:

ReferenceResolver

public static class ReferenceResolver.ReferenceCollection
extends Object

ReferenceResolver.ReferenceCollection is a value object that contains information about the target database and collection name of an association.

Since:

3.3

Author:

Christoph Strobl

Constructor Summary

Constructors

Constructor	Description
ReferenceCollection(@Nullable String database, String collection)

Method Summary

Modifier and Type	Method	Description
static ReferenceResolver.ReferenceCollection	fromDBRef(com.mongodb.DBRef dbRef)	Create a new instance of ReferenceResolver.ReferenceCollection from the given DBRef.
String	getCollection()	Get the target collection name.
@Nullable String	getDatabase()	Get the target database name.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ReferenceCollection

public ReferenceCollection(@Nullable String database,
 String collection)

Parameters:

database - can be null to indicate the configured default database should be used.

collection - the target collection name. Must not be null.

Method Details

fromDBRef

public static ReferenceResolver.ReferenceCollection fromDBRef(com.mongodb.DBRef dbRef)

Create a new instance of ReferenceResolver.ReferenceCollection from the given DBRef.

Parameters:

dbRef - must not be null.

Returns:

new instance of ReferenceResolver.ReferenceCollection.

getCollection

public String getCollection()

Get the target collection name.

Returns:

never null.

getDatabase

public @Nullable String getDatabase()

Get the target database name. If null the default database should be used.

Returns:

can be null.