Skip navigation links
A C D E F G H I K M N O P R S T U V W 

A

addCustomCodec(codec) - Method in class org.litote.kmongo.util.ObjectMappingConfiguration
Adds a custom codec.

C

calculatePath(property) - Method in class org.litote.kmongo.service.ClassMappingType
 
calculatePath(property) - Method in interface org.litote.kmongo.service.ClassMappingTypeService
 
ClassMappingType - Class in org.litote.kmongo.service
ClassMappingTypeKt - Class in org.litote.kmongo.service
 
ClassMappingTypeKt() - Constructor for class org.litote.kmongo.service.ClassMappingTypeKt
 
ClassMappingTypeService - Interface in org.litote.kmongo.service
Provides an object mapping utility using java.util.ServiceLoader.
ClassMappingTypeService() - Constructor for interface org.litote.kmongo.service.ClassMappingTypeService
 
ClassMappingTypeService.DefaultImpls - Class in org.litote.kmongo.service
Provides an object mapping utility using java.util.ServiceLoader.
ClassMappingTypeServiceKt - Class in org.litote.kmongo.service
 
ClassMappingTypeServiceKt() - Constructor for class org.litote.kmongo.service.ClassMappingTypeServiceKt
 
codecRegistry(baseCodecRegistry) - Method in class org.litote.kmongo.service.ClassMappingType
Returns a codec registry built with baseCodecRegistry.
codecRegistry(baseCodecRegistry) - Method in interface org.litote.kmongo.service.ClassMappingTypeService
Returns a codec registry built with baseCodecRegistry.
codecRegistry($this, baseCodecRegistry) - Static method in class org.litote.kmongo.service.ClassMappingTypeService.DefaultImpls
Returns a codec registry built with baseCodecRegistry.
codecRegistryWithCustomCodecs(baseCodecRegistry, coreCodeRegistry) - Method in class org.litote.kmongo.service.ClassMappingType
 
codecRegistryWithCustomCodecs(baseCodecRegistry, coreCodeRegistry) - Method in interface org.litote.kmongo.service.ClassMappingTypeService
 
codecRegistryWithCustomCodecs($this, baseCodecRegistry, coreCodeRegistry) - Static method in class org.litote.kmongo.service.ClassMappingTypeService.DefaultImpls
 
CollectionNameFormatter - Class in org.litote.kmongo.util
To configure the default collection name strategy - default is camel case. To be used before KMongo initialization.
component1() - Method in class org.litote.kmongo.id.WrappedObjectId
 
copy(id) - Method in class org.litote.kmongo.id.WrappedObjectId
An Id containing a ObjectId.
coreCodecRegistry(baseCodecRegistry) - Method in class org.litote.kmongo.service.ClassMappingType
 
coreCodecRegistry(baseCodecRegistry) - Method in interface org.litote.kmongo.service.ClassMappingTypeService
 
createMongoClient(connectionString) - Method in interface org.litote.kmongo.service.MongoClientProviderService
Create a new client with the given connection string.

D

defaultCollectionName(clazz) - Method in class org.litote.kmongo.util.KMongoUtil
 
defaultCollectionNameBuilder - Static variable in class org.litote.kmongo.util.CollectionNameFormatter
To change the default collection name strategy - default is camel case.
DefaultImpls() - Constructor for class org.litote.kmongo.service.ClassMappingTypeService.DefaultImpls
 

E

EMPTY_JSON - Static variable in class org.litote.kmongo.util.KMongoUtil
 
encodeValue(writer, value, codecRegistry) - Method in class org.litote.kmongo.util.KMongoUtil
 
equals(p) - Method in class org.litote.kmongo.id.WrappedObjectId
An Id containing a ObjectId.
extractId(obj, clazz) - Method in class org.litote.kmongo.util.KMongoUtil
 

F

filterBaseCodecRegistry(baseCodecRegistry) - Method in class org.litote.kmongo.service.ClassMappingType
 
filterBaseCodecRegistry($this, baseCodecRegistry) - Static method in class org.litote.kmongo.service.ClassMappingTypeService.DefaultImpls
 
filterBaseCodecRegistry(baseCodecRegistry) - Method in interface org.litote.kmongo.service.ClassMappingTypeService
 
filterIdToBson(obj, filterNullProperties) - Method in class org.litote.kmongo.service.ClassMappingType
 
filterIdToBson(obj, filterNullProperties) - Method in interface org.litote.kmongo.service.ClassMappingTypeService
 
filterIdToBson(obj, filterNullProperties) - Method in class org.litote.kmongo.util.KMongoUtil
 
findIdProperty(type) - Method in class org.litote.kmongo.service.ClassMappingType
 
findIdProperty(type) - Method in interface org.litote.kmongo.service.ClassMappingTypeService
 
findValue($this$findValue, path) - Static method in class org.litote.kmongo.SharedExtensionsKt
Find the value for the specified path from the document.
forceService(service) - Method in class org.litote.kmongo.service.ClassMappingType
Do not use the ClassMappingTypeService.priority method do define the service used, and force the use of the specified service. Use this method at startup only.
formatJson($this$formatJson) - Static method in class org.litote.kmongo.SharedExtensionsKt
Format this string to remove space(s) between $ and next char
formatJson(json) - Method in class org.litote.kmongo.util.KMongoUtil
 

G

generateIdsAsObjectIds() - Method in class org.litote.kmongo.util.ObjectMappingConfiguration
Generates Id (using newId) as ObjectId (default behaviour).
generateIdsAsStrings() - Method in class org.litote.kmongo.util.ObjectMappingConfiguration
Generates Id (using newId) as String.
generateNewId() - Method in class org.litote.kmongo.id.ObjectIdGenerator
 
generateNewId() - Method in class org.litote.kmongo.id.ObjectIdToStringGenerator
 
generateNewIdForIdClass(idClass) - Method in class org.litote.kmongo.util.KMongoUtil
 
getBson($this$bson) - Static method in class org.litote.kmongo.SharedExtensionsKt
Get the org.bson.BsonValue of this string.
getDefaultCodecRegistry() - Method in class org.litote.kmongo.util.KMongoUtil
 
getDefaultCollectionNameBuilder() - Method in class org.litote.kmongo.util.CollectionNameFormatter
To change the default collection name strategy - default is camel case.
getDefaultNullSerialization() - Method in class org.litote.kmongo.service.ClassMappingType
 
getDefaultNullSerialization($this) - Static method in class org.litote.kmongo.service.ClassMappingTypeService.DefaultImpls
 
getDefaultNullSerialization() - Method in interface org.litote.kmongo.service.ClassMappingTypeService
 
getEMPTY_BSON() - Static method in class org.litote.kmongo.MongoUtilKt
An immutable empty Bson.
getField() - Method in class org.litote.kmongo.util.SingleProjection
 
getField1() - Method in class org.litote.kmongo.util.PairProjection
 
getField1() - Method in class org.litote.kmongo.util.TripleProjection
 
getField2() - Method in class org.litote.kmongo.util.PairProjection
 
getField2() - Method in class org.litote.kmongo.util.TripleProjection
 
getField3() - Method in class org.litote.kmongo.util.TripleProjection
 
getId() - Method in class org.litote.kmongo.id.WrappedObjectId
 
getIdBsonValue(idValue) - Method in class org.litote.kmongo.util.KMongoUtil
 
getIdClass() - Method in class org.litote.kmongo.id.ObjectIdGenerator
 
getIdClass() - Method in class org.litote.kmongo.id.ObjectIdToStringGenerator
 
getIdValue(idProperty, instance) - Method in class org.litote.kmongo.service.ClassMappingType
 
getIdValue(idProperty, instance) - Method in interface org.litote.kmongo.service.ClassMappingTypeService
 
getIdValue(value) - Method in class org.litote.kmongo.util.KMongoUtil
 
getJson($this$json) - Static method in class org.litote.kmongo.SharedExtensionsKt
Get the extended json representation of this object
getOptionsAsString(pattern) - Method in class org.litote.kmongo.util.PatternUtil
Returns pattern options as string.
getPath(property) - Method in class org.litote.kmongo.service.ClassMappingType
 
getPath($this, property) - Static method in class org.litote.kmongo.service.ClassMappingTypeService.DefaultImpls
 
getPath(property) - Method in interface org.litote.kmongo.service.ClassMappingTypeService
 
getSerializeNull() - Method in class org.litote.kmongo.util.ObjectMappingConfiguration
Are null value serialized? Default to true for jackson & kotlinx.serialization. Default to false for native driver (for backward compatibility).
getUpdateOnlyNotNullProperties() - Method in class org.litote.kmongo.util.UpdateConfiguration
If set to true, only not null properties are updated. If set to false (default value), null properties are updated to null.
getWrappedIdClass() - Method in class org.litote.kmongo.id.ObjectIdGenerator
 
getWrappedIdClass() - Method in class org.litote.kmongo.id.ObjectIdToStringGenerator
 

H

hashCode() - Method in class org.litote.kmongo.id.WrappedObjectId
An Id containing a ObjectId.

I

idFilterQuery(id) - Method in class org.litote.kmongo.util.KMongoUtil
 
IdsKt - Class in org.litote.kmongo.id
 
IdsKt() - Constructor for class org.litote.kmongo.id.IdsKt
 
IdTransformer - Class in org.litote.kmongo.id
To manage id wrapped value.
IndexModel($this$IndexModel, keys, options) - Static method in class org.litote.kmongo.SharedExtensionsKt
Construct an instance with the given keys and options.
INSTANCE - Static variable in class org.litote.kmongo.id.IdTransformer
To manage id wrapped value.
INSTANCE - Static variable in class org.litote.kmongo.id.ObjectIdGenerator
ObjectId generator.
INSTANCE - Static variable in class org.litote.kmongo.id.ObjectIdToStringGenerator
ObjectId based String generator.
INSTANCE - Static variable in class org.litote.kmongo.service.ClassMappingType
INSTANCE - Static variable in class org.litote.kmongo.service.MongoClientProvider
Provides a MongoClient class. Common interface for sync and async driver. This object is mainly used for tests.
INSTANCE - Static variable in class org.litote.kmongo.util.CollectionNameFormatter
To configure the default collection name strategy - default is camel case. To be used before KMongo initialization.
INSTANCE - Static variable in class org.litote.kmongo.util.KMongoUtil
Internal utility methods
INSTANCE - Static variable in class org.litote.kmongo.util.ObjectMappingConfiguration
Default object mapping configuration options. Set values before KMongo initialization.
INSTANCE - Static variable in class org.litote.kmongo.util.PatternUtil
Provides pattern options copied from mongo PatternCodec.
INSTANCE - Static variable in class org.litote.kmongo.util.UpdateConfiguration
Default update operations configuration.

K

KMongoUtil - Class in org.litote.kmongo.util
Internal utility methods

M

MongoClientProvider - Class in org.litote.kmongo.service
Provides a MongoClient class. Common interface for sync and async driver. This object is mainly used for tests.
MongoClientProviderService<T extends Closeable> - Interface in org.litote.kmongo.service
Provides a MongoClient class using java.util.ServiceLoader.
MongoClientProviderService() - Constructor for interface org.litote.kmongo.service.MongoClientProviderService
 
MongoId - Annotation Type in org.litote.kmongo.id
Deprecated. 
MongoId() - Constructor for annotation type org.litote.kmongo.id.MongoId
Deprecated.
 
MongoOperator - Enum in org.litote.kmongo
List all known mongo operators, used in string templates.
MongoProperty - Annotation Type in org.litote.kmongo.id
Deprecated. 
MongoProperty() - Constructor for annotation type org.litote.kmongo.id.MongoProperty
Deprecated.
 
MongoUtilKt - Class in org.litote.kmongo
 
MongoUtilKt() - Constructor for class org.litote.kmongo.MongoUtilKt
 

N

newObjectId() - Method in class org.litote.kmongo.id.ObjectIdGenerator
Generates a new WrappedObjectId.
newStringId() - Method in class org.litote.kmongo.id.ObjectIdToStringGenerator
Generates a new StringId.

O

ObjectIdGenerator - Class in org.litote.kmongo.id
ObjectId generator.
ObjectIdToStringGenerator - Class in org.litote.kmongo.id
ObjectId based String generator.
ObjectMappingConfiguration - Class in org.litote.kmongo.util
Default object mapping configuration options. Set values before KMongo initialization.
org.litote.kmongo - package org.litote.kmongo
 
org.litote.kmongo.id - package org.litote.kmongo.id
 
org.litote.kmongo.service - package org.litote.kmongo.service
 
org.litote.kmongo.util - package org.litote.kmongo.util
 

P

PairProjection<F1,F2> - Class in org.litote.kmongo.util
Pair projection (two fields).
PairProjection(field1, field2) - Constructor for class org.litote.kmongo.util.PairProjection
Pair projection (two fields).
pairProjectionCodecRegistry(property1, property1Class, property2, property2Class, baseRegistry) - Static method in class org.litote.kmongo.util.SimpleProjectionsKt
This method is not part of the public API and may be removed or changed at any time.
PatternUtil - Class in org.litote.kmongo.util
Provides pattern options copied from mongo PatternCodec.
priority() - Method in class org.litote.kmongo.service.ClassMappingType
Priority of this service. Greater is better.
priority() - Method in interface org.litote.kmongo.service.ClassMappingTypeService
Priority of this service. Greater is better.

R

resetConfiguration() - Method in class org.litote.kmongo.service.ClassMappingType
 
resetConfiguration($this) - Static method in class org.litote.kmongo.service.ClassMappingTypeService.DefaultImpls
 
resetConfiguration() - Method in interface org.litote.kmongo.service.ClassMappingTypeService
 

S

setDefaultCollectionNameBuilder(p) - Method in class org.litote.kmongo.util.CollectionNameFormatter
To change the default collection name strategy - default is camel case.
setModifier(obj, updateOnlyNotNullProperties) - Method in class org.litote.kmongo.util.KMongoUtil
 
setSerializeNull(p) - Method in class org.litote.kmongo.util.ObjectMappingConfiguration
Are null value serialized? Default to true for jackson & kotlinx.serialization. Default to false for native driver (for backward compatibility).
setUpdateOnlyNotNullProperties(p) - Method in class org.litote.kmongo.util.UpdateConfiguration
If set to true, only not null properties are updated. If set to false (default value), null properties are updated to null.
SharedExtensionsKt - Class in org.litote.kmongo
 
SharedExtensionsKt() - Constructor for class org.litote.kmongo.SharedExtensionsKt
 
SimpleProjectionsKt - Class in org.litote.kmongo.util
 
SimpleProjectionsKt() - Constructor for class org.litote.kmongo.util.SimpleProjectionsKt
 
SingleProjection<F> - Class in org.litote.kmongo.util
Single projection (one field only).
SingleProjection(field) - Constructor for class org.litote.kmongo.util.SingleProjection
Single projection (one field only).
singleProjectionCodecRegistry(property, propertyClass, baseRegistry) - Static method in class org.litote.kmongo.util.SimpleProjectionsKt
This method is not part of the public API and may be removed or changed at any time.

T

toBson(json) - Method in class org.litote.kmongo.util.KMongoUtil
 
toBson(json, type) - Method in class org.litote.kmongo.util.KMongoUtil
 
toBsonList(json, codecRegistry) - Method in class org.litote.kmongo.util.KMongoUtil
 
toBsonModifier(obj, updateOnlyNotNullProperties) - Method in class org.litote.kmongo.util.KMongoUtil
 
toExtendedJson(obj) - Method in class org.litote.kmongo.service.ClassMappingType
 
toExtendedJson(obj) - Method in interface org.litote.kmongo.service.ClassMappingTypeService
 
toExtendedJson(obj) - Method in class org.litote.kmongo.util.KMongoUtil
 
toId($this$toId) - Static method in class org.litote.kmongo.id.IdsKt
Create a new Id from the current ObjectId.
toString() - Method in class org.litote.kmongo.id.WrappedObjectId
 
toString() - Method in enum org.litote.kmongo.MongoOperator
 
toWriteModel(json, codecRegistry, type) - Method in class org.litote.kmongo.util.KMongoUtil
 
TripleProjection<F1,F2,F3> - Class in org.litote.kmongo.util
Triple projection (three fields).
TripleProjection(field1, field2, field3) - Constructor for class org.litote.kmongo.util.TripleProjection
Triple projection (three fields).
tripleProjectionCodecRegistry(property1, property1Class, property2, property2Class, property3, property3Class, baseRegistry) - Static method in class org.litote.kmongo.util.SimpleProjectionsKt
This method is not part of the public API and may be removed or changed at any time.

U

unwrapId(id) - Method in class org.litote.kmongo.id.IdTransformer
 
UpdateConfiguration - Class in org.litote.kmongo.util
Default update operations configuration.
useCamelCaseCollectionNameBuilder(fromClass) - Method in class org.litote.kmongo.util.CollectionNameFormatter
Use Camel Case default collection name builder.
useLowerCaseCollectionNameBuilder(fromClass) - Method in class org.litote.kmongo.util.CollectionNameFormatter
Use Lower Case default collection name builder.
useSnakeCaseCollectionNameBuilder(fromClass) - Method in class org.litote.kmongo.util.CollectionNameFormatter
Use Snake Case default collection name builder.

V

value() - Method in annotation type org.litote.kmongo.id.MongoProperty
Deprecated.
 

W

wrapId(id) - Method in class org.litote.kmongo.id.IdTransformer
 
WrappedObjectId<T> - Class in org.litote.kmongo.id
An Id containing a ObjectId.
WrappedObjectId(id) - Constructor for class org.litote.kmongo.id.WrappedObjectId
An Id containing a ObjectId.
WrappedObjectId(id) - Constructor for class org.litote.kmongo.id.WrappedObjectId
 
A C D E F G H I K M N O P R S T U V W 
Skip navigation links