org.springframework.data.mongodb.core

Class CollectionOptions

java.lang.Object

org.springframework.data.mongodb.core.CollectionOptions

public class CollectionOptions
extends Object

Provides a simple wrapper to encapsulate the variety of settings you can use when creating a collection.

Author:

Thomas Risberg, Christoph Strobl, Mark Paluch, Andreas Zink

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CollectionOptions.ValidationOptions Encapsulation of ValidationOptions options.

Constructor Summary

Constructors

Constructor and Description
CollectionOptions(Long size, Long maxDocuments, Boolean capped) Deprecated. since 2.0 please use empty() as entry point.

Method Summary

Modifier and Type	Method and Description
CollectionOptions	capped() Create new CollectionOptions with already given settings and capped set to true.
CollectionOptions	collation(Collation collation) Create new CollectionOptions with already given settings and collation set to given value.
CollectionOptions	disableValidation() Create new CollectionOptions with already given settings and validationLevel set to ValidationLevel.OFF.
static CollectionOptions	empty() Create new empty CollectionOptions.
CollectionOptions	failOnValidationError() Create new CollectionOptions with already given settings and validationAction set to ValidationAction.ERROR.
Optional<Boolean>	getCapped() Get if the collection should be capped.
Optional<Collation>	getCollation() Get the Collation settings.
Optional<Long>	getMaxDocuments() Get the max number of documents the collection should be limited to.
Optional<Long>	getSize() Get the size in bytes the collection should be limited to.
Optional<CollectionOptions.ValidationOptions>	getValidationOptions() Get the MongoJsonSchema for the collection.
static CollectionOptions	just(Collation collation) Create new CollectionOptions by just providing the Collation to use.
CollectionOptions	maxDocuments(long maxDocuments) Create new CollectionOptions with already given settings and maxDocuments set to given value.
CollectionOptions	moderateValidation() Create new CollectionOptions with already given settings and validationLevel set to ValidationLevel.MODERATE.
CollectionOptions	schema(MongoJsonSchema schema) Create new CollectionOptions with already given settings and validationOptions set to given MongoJsonSchema.
CollectionOptions	schemaValidationAction(com.mongodb.client.model.ValidationAction validationAction) Create new CollectionOptions with already given settings and validationAction set given ValidationAction.
CollectionOptions	schemaValidationLevel(com.mongodb.client.model.ValidationLevel validationLevel) Create new CollectionOptions with already given settings and validationLevel set given ValidationLevel.
CollectionOptions	size(long size) Create new CollectionOptions with already given settings and size set to given value.
CollectionOptions	strictValidation() Create new CollectionOptions with already given settings and validationLevel set to ValidationLevel.STRICT.
CollectionOptions	validation(CollectionOptions.ValidationOptions validationOptions) Create new CollectionOptions with the given CollectionOptions.ValidationOptions.
CollectionOptions	validator(Validator validator) Create new CollectionOptions with already given settings and validationOptions set to given Validator.
CollectionOptions	warnOnValidationError() Create new CollectionOptions with already given settings and validationAction set to ValidationAction.WARN.

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionOptions

@Deprecated
public CollectionOptions(@Nullable
                                     Long size,
                                     @Nullable
                                     Long maxDocuments,
                                     @Nullable
                                     Boolean capped)

Deprecated. since 2.0 please use empty() as entry point.

Constructs a new CollectionOptions instance.

Parameters:

size - the collection size in bytes, this data space is preallocated. Can be null.

maxDocuments - the maximum number of documents in the collection. Can be null.

capped - true to created a "capped" collection (fixed size with auto-FIFO behavior based on insertion order), false otherwise. Can be null.

Method Detail

just

public static CollectionOptions just(Collation collation)

Create new CollectionOptions by just providing the Collation to use.

Parameters:

collation - must not be null.

Returns:

new CollectionOptions.

Since:

2.0

empty

public static CollectionOptions empty()

Create new empty CollectionOptions.

Returns:

new CollectionOptions.

Since:

2.0

capped

public CollectionOptions capped()

Create new CollectionOptions with already given settings and capped set to true.
NOTE Using capped collections requires defining #size(int).

Returns:

new CollectionOptions.

Since:

2.0

maxDocuments

public CollectionOptions maxDocuments(long maxDocuments)

Create new CollectionOptions with already given settings and maxDocuments set to given value.

Parameters:

maxDocuments - can be null.

Returns:

new CollectionOptions.

Since:

2.0

size

public CollectionOptions size(long size)

Create new CollectionOptions with already given settings and size set to given value.

Parameters:

size - can be null.

Returns:

new CollectionOptions.

Since:

2.0

collation

public CollectionOptions collation(@Nullable
                                   Collation collation)

Create new CollectionOptions with already given settings and collation set to given value.

Parameters:

collation - can be null.

Returns:

new CollectionOptions.

Since:

2.0

schema

public CollectionOptions schema(@Nullable
                                MongoJsonSchema schema)

Create new CollectionOptions with already given settings and validationOptions set to given MongoJsonSchema.

Parameters:

schema - can be null.

Returns:

new CollectionOptions.

Since:

2.1

validator

public CollectionOptions validator(@Nullable
                                   Validator validator)

Create new CollectionOptions with already given settings and validationOptions set to given Validator.

Parameters:

validator - can be null.

Returns:

new CollectionOptions.

Since:

2.1

disableValidation

public CollectionOptions disableValidation()

Create new CollectionOptions with already given settings and validationLevel set to ValidationLevel.OFF.

Returns:

new CollectionOptions.

Since:

2.1

strictValidation

public CollectionOptions strictValidation()

Create new CollectionOptions with already given settings and validationLevel set to ValidationLevel.STRICT.

Returns:

new CollectionOptions.

Since:

2.1

moderateValidation

public CollectionOptions moderateValidation()

Create new CollectionOptions with already given settings and validationLevel set to ValidationLevel.MODERATE.

Returns:

new CollectionOptions.

Since:

2.1

warnOnValidationError

public CollectionOptions warnOnValidationError()

Create new CollectionOptions with already given settings and validationAction set to ValidationAction.WARN.

Returns:

new CollectionOptions.

Since:

2.1

failOnValidationError

public CollectionOptions failOnValidationError()

Create new CollectionOptions with already given settings and validationAction set to ValidationAction.ERROR.

Returns:

new CollectionOptions.

Since:

2.1

schemaValidationLevel

public CollectionOptions schemaValidationLevel(com.mongodb.client.model.ValidationLevel validationLevel)

Create new CollectionOptions with already given settings and validationLevel set given ValidationLevel.

Parameters:

validationLevel - must not be null.

Returns:

new CollectionOptions.

Since:

2.1

schemaValidationAction

public CollectionOptions schemaValidationAction(com.mongodb.client.model.ValidationAction validationAction)

Create new CollectionOptions with already given settings and validationAction set given ValidationAction.

Parameters:

validationAction - must not be null.

Returns:

new CollectionOptions.

Since:

2.1

validation

public CollectionOptions validation(CollectionOptions.ValidationOptions validationOptions)

Create new CollectionOptions with the given CollectionOptions.ValidationOptions.

Parameters:

validationOptions - must not be null. Use CollectionOptions.ValidationOptions.none() to remove validation.

Returns:

new CollectionOptions.

Since:

2.1

getMaxDocuments

public Optional<Long> getMaxDocuments()

Get the max number of documents the collection should be limited to.

Returns:

Optional.empty() if not set.

getSize

public Optional<Long> getSize()

Get the size in bytes the collection should be limited to.

Returns:

Optional.empty() if not set.

getCapped

public Optional<Boolean> getCapped()

Get if the collection should be capped.

Returns:

Optional.empty() if not set.

Since:

2.0

getCollation

public Optional<Collation> getCollation()

Get the Collation settings.

Returns:

Optional.empty() if not set.

Since:

2.0

getValidationOptions

public Optional<CollectionOptions.ValidationOptions> getValidationOptions()

Get the MongoJsonSchema for the collection.

Returns:

Optional.empty() if not set.

Since:

2.1