com.allanbank.mongodb.client.message

Class CreateIndexCommand

java.lang.Object

com.allanbank.mongodb.client.message.AbstractMessage

com.allanbank.mongodb.client.message.Command

com.allanbank.mongodb.client.message.CreateIndexCommand

All Implemented Interfaces:

Message

public class CreateIndexCommand
extends Command

Helper class to make generating a createIndexes command easier.

See Also:

createIndexes reference manual.

API Warning:

This class is NOT part of the drivers API. This class may be mutated in incompatible ways between any two releases of the driver.

Copyright ©:

2014, Allanbank Consulting, Inc., All Rights Reserved

Field Summary

Fields

Modifier and Type	Field and Description
static Version	REQUIRED_VERSION The first version of MongoDB to support the createIndexes command.
static VersionRange	REQUIRED_VERSION_RANGE The required server version range for the createIndexes command.

Fields inherited from class com.allanbank.mongodb.client.message.Command

COMMAND_COLLECTION

Fields inherited from class com.allanbank.mongodb.client.message.AbstractMessage

HEADER_SIZE, myCollectionName, myDatabaseName

Constructor Summary

Constructors

Constructor and Description
CreateIndexCommand(String databaseName, String collectionName, Element[] keys, String indexName, DocumentAssignable options) Create a new CreateIndexCommand.

Method Summary

Methods

Modifier and Type	Method and Description
static String	buildIndexName(Element... keys) Generates a name for the index based on the keys.
boolean	equals(Object object) Determines if the passed object is of this same type as this object and if so that its fields are equal.
int	hashCode() Computes a reasonable hash code.

Methods inherited from class com.allanbank.mongodb.client.message.Command

getCommand, getOperationName, getRoutingDocument, isAllowJumbo, setAllowJumbo, size, toString, validateSize, write, write

Methods inherited from class com.allanbank.mongodb.client.message.AbstractMessage

finishHeader, getCollectionName, getDatabaseName, getReadPreference, getRequiredVersionRange, init, writeHeader, writeHeader

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

REQUIRED_VERSION

public static final Version REQUIRED_VERSION

The first version of MongoDB to support the createIndexes command.

REQUIRED_VERSION_RANGE

public static final VersionRange REQUIRED_VERSION_RANGE

The required server version range for the createIndexes command.

Constructor Detail

CreateIndexCommand

public CreateIndexCommand(String databaseName,
                  String collectionName,
                  Element[] keys,
                  String indexName,
                  DocumentAssignable options)

Create a new CreateIndexCommand.

Parameters:

databaseName - The name of the database.

collectionName - The name of the collection the command is using. This should be the real collection and not $cmd.

keys - The index keys for the index.

indexName - The name of the index.

options - Options for the index. May be null.

Method Detail

buildIndexName

public static String buildIndexName(Element... keys)

Generates a name for the index based on the keys.

Parameters:

keys - The keys for the index.

Returns:

The name for the index.

equals

public boolean equals(Object object)

Determines if the passed object is of this same type as this object and if so that its fields are equal.

Overrides:

equals in class Command

Parameters:

object - The object to compare to.

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

Computes a reasonable hash code.

Overrides:

hashCode in class Command

Returns:

The hash code value.