Module spring.data.mongodb

Package org.springframework.data.mongodb.core.index

Class CompoundIndexDefinition

java.lang.Object

org.springframework.data.mongodb.core.index.Index

org.springframework.data.mongodb.core.index.CompoundIndexDefinition

All Implemented Interfaces:

IndexDefinition

public class CompoundIndexDefinition
extends Index

Index definition to span multiple keys.

Since:

1.5

Author:

Christoph Strobl

Constructor Summary

Constructors

Constructor	Description
CompoundIndexDefinition(org.bson.Document keys)	Creates a new CompoundIndexDefinition for the given keys.

Method Summary

Modifier and Type	Method	Description
org.bson.Document	getIndexKeys()	Get the Document containing properties covered by the index.

Methods inherited from class org.springframework.data.mongodb.core.index.Index

background, collation, expire, expire, expire, getIndexOptions, hidden, named, on, partial, sparse, toString, unique

Methods inherited from class java.lang.Object

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

Constructor Details

CompoundIndexDefinition

public CompoundIndexDefinition(org.bson.Document keys)

Creates a new CompoundIndexDefinition for the given keys.

Parameters:

keys - must not be null.

Method Details

getIndexKeys

public org.bson.Document getIndexKeys()

Description copied from interface: IndexDefinition

Get the Document containing properties covered by the index.

Specified by:

getIndexKeys in interface IndexDefinition

Overrides:

getIndexKeys in class Index

Returns:

never null.