org.dizitart.no2

Class IndexOptions

java.lang.Object

org.dizitart.no2.IndexOptions

public class IndexOptions
extends java.lang.Object

Represents options to apply while creating an Index.

Since:

1.0

See Also:

PersistentCollection.createIndex(String, IndexOptions)

Constructor Summary

Constructors

Constructor and Description
IndexOptions()

Method Summary

Modifier and Type	Method and Description
IndexType	getIndexType() Specifies the type of an index to create.
static IndexOptions	indexOptions(IndexType indexType) Creates an IndexOptions with the specified indexType.
static IndexOptions	indexOptions(IndexType indexType, boolean async) Creates an IndexOptions with the specified indexType and async flag.
boolean	isAsync() Indicates whether an index to be created in a non-blocking way.
void	setAsync(boolean async) Indicates whether an index to be created in a non-blocking way.
void	setIndexType(IndexType indexType) Specifies the type of an index to create.

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexOptions

public IndexOptions()

Method Detail

indexOptions

public static IndexOptions indexOptions(IndexType indexType)

Creates an IndexOptions with the specified indexType. Index creation will be synchronous with this option.

Parameters:

indexType - the type of index to be created.

Returns:

a new synchronous index creation option.

indexOptions

public static IndexOptions indexOptions(IndexType indexType,
                                        boolean async)

Creates an IndexOptions with the specified indexType and async flag.

Parameters:

indexType - the type of index to be created.

async - if set to true then the index would be created asynchronously; otherwise synchronously.

Returns:

a new index creation option.

getIndexType

@Generated(value="lombok")
public IndexType getIndexType()

Specifies the type of an index to create.

setIndexType

@Generated(value="lombok")
public void setIndexType(IndexType indexType)

Specifies the type of an index to create.

Parameters:

indexType - type of an index.

isAsync

@Generated(value="lombok")
public boolean isAsync()

Indicates whether an index to be created in a non-blocking way.

otherwise create index operation will wait until all existing documents are indexed.

See Also:

PersistentCollection.createIndex(String, IndexOptions)

setAsync

@Generated(value="lombok")
public void setAsync(boolean async)

Indicates whether an index to be created in a non-blocking way.

Parameters:

async - if set to true then the index will be created asynchronously; otherwise create index operation will wait until all existing documents are indexed.

See Also:

PersistentCollection.createIndex(String, IndexOptions)