org.apache.maven.index.packer

Interface IndexPacker

All Known Implementing Classes:

DefaultIndexPacker

public interface IndexPacker

An index packer used to create transfer index format that can be used by the IndexUpdater.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ROLE

Method Summary

Modifier and Type	Method and Description
void	packIndex(IndexPackingRequest request) Pack a context into a target directory.

Field Detail

ROLE

static final java.lang.String ROLE

Method Detail

packIndex

void packIndex(IndexPackingRequest request)
        throws java.io.IOException,
               java.lang.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:

java.lang.IllegalArgumentException - when the targetDir already exists and is not a writable directory.

java.io.IOException - on lethal IO problem