Index (NetarchiveSuite 7.1 API)

java.lang.Object
- dk.netarkivet.common.distribute.indexserver.Index<I>

Type Parameters:

I - The type of set, this is an index for.
```
public class Index<I>
extends Object
```
An immutable pair if an index and the set this is an index for.

- Constructor Summary
  
  Constructors
  Constructor Description
  
  Index(File indexFile, I indexSet)
  Initialise the set.
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  File getIndexFile()
  Get the index file.
  
  I getIndexSet()
  Get the set this is an index for.
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Index
```
public Index(File indexFile,
             I indexSet)
```
    Initialise the set.
    
    Parameters:
    
    indexFile - The index file.
    
    indexSet - The set this is an index for. Can be null TODO Should the indexSet be allowed to be null?
    
    Throws:
    
    ArgumentNotValid - if indexFile is null.
- Method Detail
  - getIndexFile
```
public File getIndexFile()
```
    Get the index file.
    
    Returns:
    
    The index file.
  - getIndexSet
```
public I getIndexSet()
```
    Get the set this is an index for.
    
    Returns:
    
    The set this is an index for.