DefaultIndexPacker (Maven :: Indexer Core 5.1.1 API)

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.codehaus.plexus.logging.AbstractLogEnabled
- - org.apache.maven.index.packer.DefaultIndexPacker

All Implemented Interfaces:

IndexPacker, org.codehaus.plexus.logging.LogEnabled
```
@Component(role=IndexPacker.class)
public class DefaultIndexPacker
extends org.codehaus.plexus.logging.AbstractLogEnabled
implements IndexPacker
```
A default IndexPacker implementation. Creates the properties, legacy index zip and new gz files.

Author:

Tamas Cservenak, Eugene Kuleshov

Field Summary
- Fields inherited from interface org.apache.maven.index.packer.IndexPacker
  ROLE

Constructor Summary

Constructors
Constructor and Description

DefaultIndexPacker()

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`packIndex(IndexPackingRequest request)` Pack a context into a target directory.
`static void`	`packIndexArchive(IndexingContext context, OutputStream os)` Pack legacy index archive into a specified output stream

Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled
enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DefaultIndexPacker
```
public DefaultIndexPacker()
```
- Method Detail
  - packIndex
```
public void packIndex(IndexPackingRequest request)
               throws IOException,
                      IllegalArgumentException
```
    Description copied from interface: IndexPacker
    
    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.
    
    Specified by:
    
    packIndex in interface IndexPacker
    
    Throws:
    
    IOException - on lethal IO problem
    
    IllegalArgumentException - when the targetDir already exists and is not a writable directory.
  - packIndexArchive
```
public static void packIndexArchive(IndexingContext context,
                    OutputStream os)
                             throws IOException
```
    Pack legacy index archive into a specified output stream
    
    Throws:
    
    IOException

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

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