IndexPacker (Maven :: Indexer Core 5.1.1 API)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Known Implementing Classes:

DefaultIndexPacker
```
public interface IndexPacker
```
An index packer used to create transfer index format that can be used by the IndexUpdater.

Author:

Tamas Cservenak

- Field Summary
  
  Fields
  Modifier and Type Field and Description
  
  static String ROLE
- Method Summary
  
  Methods
  Modifier and Type Method and Description
  
  void packIndex(IndexPackingRequest request)
  Pack a context into a target directory.

- Field Detail
  - ROLE
```
static final String ROLE
```
- Method Detail
  - packIndex
```
void packIndex(IndexPackingRequest request)
               throws IOException,
                      IllegalArgumentException
```
    Pack a context into a target directory. If the directory does not exists, it will be created. If the directory exists, it should be writable.
    
    Parameters:
    context - the context to pack-up
    targetDir - the directory where to write results, has to be non-null
    
    Throws:
    
    IllegalArgumentException - when the targetDir already exists and is not a writable directory.
    
    IOException - on lethal IO problem

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2002-2013 The Apache Software Foundation. All Rights Reserved.