TRECResultsMatching.InputFormat (Terrier Information Retrieval Platform 5.5 API)

java.lang.Object
- java.lang.Enum<TRECResultsMatching.InputFormat>
- - org.terrier.matching.TRECResultsMatching.InputFormat

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TRECResultsMatching.InputFormat>

Enclosing class:

TRECResultsMatching
```
public static enum TRECResultsMatching.InputFormat
extends java.lang.Enum<TRECResultsMatching.InputFormat>
```
The result set input format.

Enum Constant Summary

Enum Constants
Enum Constant Description

DOCID

DOCNO
docno, docid

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static TRECResultsMatching.InputFormat`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static TRECResultsMatching.InputFormat[]`	`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
  - DOCNO
```
public static final TRECResultsMatching.InputFormat DOCNO
```
    docno, docid
  - DOCID
```
public static final TRECResultsMatching.InputFormat DOCID
```
- Method Detail
  - values
```
public static TRECResultsMatching.InputFormat[] 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 (TRECResultsMatching.InputFormat c : TRECResultsMatching.InputFormat.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static TRECResultsMatching.InputFormat valueOf(java.lang.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:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null