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

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

All Implemented Interfaces:

Serializable, Comparable<Scan.Completeness>

Enclosing class:

Scan

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

Enum Constant Summary

COUNTS
An index without positions (e.g., for count-based ranking).

POINTERS
Basic completeness level.

POSITIONS
A complete index.

Method Summary

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

POINTERS

public static final Scan.Completeness POINTERS

Basic completeness level. Just pointers (usable only for Boolean queries).

COUNTS

public static final Scan.Completeness COUNTS

An index without positions (e.g., for count-based ranking).

POSITIONS

public static final Scan.Completeness POSITIONS

A complete index.

Method Detail

values

public static Scan.Completeness[] 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.Completeness c : Scan.Completeness.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.Completeness 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