it.unimi.di.mg4j.tool
Enum Scan.IndexingType

java.lang.Object
  java.lang.Enum<Scan.IndexingType>
      it.unimi.di.mg4j.tool.Scan.IndexingType

All Implemented Interfaces:

Serializable, Comparable<Scan.IndexingType>

Enclosing class:

Scan

public static enum Scan.IndexingType
extends Enum<Scan.IndexingType>

Enum Constant Summary

REMAPPED
A remapped index—documents will be provided in separate calls, but in any order.

STANDARD
A standard index—documents will be provided in increasing order.

VIRTUAL
A virtual index—documents will be provided in any order, and a document may appear several times.

Method Summary

static Scan.IndexingType	valueOf(String name) Returns the enum constant of this type with the specified name.
static Scan.IndexingType[]	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

Enum Constant Detail

STANDARD

public static final Scan.IndexingType STANDARD

A standard index—documents will be provided in increasing order.

REMAPPED

public static final Scan.IndexingType REMAPPED

A remapped index—documents will be provided in separate calls, but in any order.

VIRTUAL

public static final Scan.IndexingType VIRTUAL

A virtual index—documents will be provided in any order, and a document may appear several times.

Method Detail

values

public static Scan.IndexingType[] 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 (Scan.IndexingType c : Scan.IndexingType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Scan.IndexingType 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