com.holonplatform.datastore.mongo.core

## Interface CollationOption

- All Superinterfaces:
    com.holonplatform.core.datastore.DatastoreOperations.WriteOption
  All Known Implementing Classes:
    DefaultCollationOption

      public interface CollationOption
      extends com.holonplatform.core.datastore.DatastoreOperations.WriteOption

  A Datastore `DatastoreOperations.WriteOption` to configure the MongoDB `Collation` to use with a specific write operation.
  Since:
    5.2.0

- - ### Method Summary

    All Methods Static Methods Instance Methods Abstract Methods Default Methods
    Modifier and Type | Method and Description
    --- | ---
    `static CollationOption` | `create(com.mongodb.client.model.Collation collation)` Create a new `CollationOption`.
    `com.mongodb.client.model.Collation` | `getCollation()` Get the MongoDB `Collation` to use.

- - ### Method Detail

    - #### getCollation

          com.mongodb.client.model.Collation getCollation()

      Get the MongoDB `Collation` to use.
      Returns:
        the MongoDB `Collation` value

    - #### create

          static CollationOption create(com.mongodb.client.model.Collation collation)

      Create a new `CollationOption`.
      Parameters:
        `collation` - The MongoDB `Collation` to use (not null)
      Returns:
        A new `CollationOption` instance

Copyright © 2019 The Holon Platform. All rights reserved.