Module spring.data.mongodb

Package org.springframework.data.mongodb.core

Class ViewOptions

java.lang.Object

org.springframework.data.mongodb.core.ViewOptions

public class ViewOptions
extends Object

Immutable object holding additional options to be applied when creating a MongoDB views.

Since:

4.0

Author:

Christoph Strobl

Constructor Summary

Constructors

Constructor	Description
ViewOptions()	Creates new instance of ViewOptions.

Method Summary

Modifier and Type	Method	Description
ViewOptions	collation(Collation collation)
Optional<Collation>	getCollation()	Get the Collation to be set.

Methods inherited from class java.lang.Object

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

Constructor Details

ViewOptions

public ViewOptions()

Creates new instance of ViewOptions.

Method Details

getCollation

public Optional<Collation> getCollation()

Get the Collation to be set.

Returns:

Optional.empty() if not set.

collation

public ViewOptions collation(Collation collation)

Parameters:

collation - the Collation to use for language-specific string comparison.

Returns:

new instance of ViewOptions.