IndexUsage (rxmicro-data-mongo 0.4.2 API)

java.lang.Object
- java.lang.Enum<IndexUsage>
- - io.rxmicro.data.mongo.IndexUsage

All Implemented Interfaces:

io.rxmicro.model.NotStandardSerializableEnum, Serializable, Comparable<IndexUsage>
```
public enum IndexUsage
extends Enum<IndexUsage>
implements io.rxmicro.model.NotStandardSerializableEnum
```
Allows activating or disabling the index usage.

Since:

0.1

Author:

nedis

See Also:

SortOrder, Pageable, RepeatParameter, ProjectionType

Enum Constant Summary

Enum Constants
Enum Constant Description

EXCLUDE
Excludes index usage.

INCLUDE
Includes index usage.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`mongo()`
`static IndexUsage`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static IndexUsage[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.rxmicro.model.NotStandardSerializableEnum
sql

- Enum Constant Detail
  - INCLUDE
```
public static final IndexUsage INCLUDE
```
    Includes index usage.
  - EXCLUDE
```
public static final IndexUsage EXCLUDE
```
    Excludes index usage.
- Method Detail
  - values
```
public static IndexUsage[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (IndexUsage c : IndexUsage.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static IndexUsage valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - mongo
```
public int mongo()
```
    Specified by:
    
    mongo in interface io.rxmicro.model.NotStandardSerializableEnum