it.unimi.dsi.archive4j
Enum ArchiveLoader.PropertyKeys

java.lang.Object
  extended by java.lang.Enum<ArchiveLoader.PropertyKeys>
      extended by it.unimi.dsi.archive4j.ArchiveLoader.PropertyKeys
All Implemented Interfaces:
Serializable, Comparable<ArchiveLoader.PropertyKeys>
Enclosing class:
ArchiveLoader

public static enum ArchiveLoader.PropertyKeys
extends Enum<ArchiveLoader.PropertyKeys>

The (capitalized) names for archive properties.


Enum Constant Summary
CLASS
          The name of the class that should load the archive.
DOCUMENTS
          The number of documents in the archive.
INMEMORY
          Specify whether the archive is to be loaded in core memory.
TERMS
          The number of terms in the archive.
WORDS
          The number of words in the archive (i.e., the sum of the lengths of all documents).
 
Method Summary
static ArchiveLoader.PropertyKeys valueOf(String name)
          Returns the enum constant of this type with the specified name.
static ArchiveLoader.PropertyKeys[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

CLASS

public static final ArchiveLoader.PropertyKeys CLASS
The name of the class that should load the archive.


DOCUMENTS

public static final ArchiveLoader.PropertyKeys DOCUMENTS
The number of documents in the archive.


TERMS

public static final ArchiveLoader.PropertyKeys TERMS
The number of terms in the archive.


WORDS

public static final ArchiveLoader.PropertyKeys WORDS
The number of words in the archive (i.e., the sum of the lengths of all documents).


INMEMORY

public static final ArchiveLoader.PropertyKeys INMEMORY
Specify whether the archive is to be loaded in core memory.

Method Detail

values

public static final ArchiveLoader.PropertyKeys[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(ArchiveLoader.PropertyKeys c : ArchiveLoader.PropertyKeys.values())
        System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they're declared

valueOf

public static ArchiveLoader.PropertyKeys 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