org.apache.jackrabbit.oak.plugins.blob

Class GarbageCollectorFileState

java.lang.Object

org.apache.jackrabbit.oak.plugins.blob.GarbageCollectorFileState

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class GarbageCollectorFileState
extends java.lang.Object
implements java.io.Closeable

Class for keeping the file system state of the garbage collection. Also, manages any temporary files needed as well as external sorting.

Constructor Summary

Constructors

Constructor and Description
GarbageCollectorFileState(java.lang.String root) Instantiates a new garbage collector file state.

Method Summary

Modifier and Type	Method and Description
void	close() Completes the process by deleting the files.
static java.io.File	copy(java.io.InputStream stream)
java.io.File	getAvailableRefs() Gets the file storing the available references.
java.io.File	getGarbage() Gets the storing the garbage.
java.io.File	getGcCandidates() Gets the file storing the gc candidates.
java.io.File	getMarkedRefs() Gets the file storing the marked references.
static void	merge(java.util.List<java.io.File> files, java.io.File output)
static void	sort(java.io.File file) Sorts the given file externally.
static void	sort(java.io.File file, java.util.Comparator<java.lang.String> comparator) Sorts the given file externally with the given comparator.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GarbageCollectorFileState

public GarbageCollectorFileState(java.lang.String root)
                          throws java.io.IOException

Instantiates a new garbage collector file state.

Parameters:

root - path of the root directory under which the files created during gc are stored

Throws:

java.io.IOException

Method Detail

getMarkedRefs

public java.io.File getMarkedRefs()

Gets the file storing the marked references.

Returns:

the marked references

getAvailableRefs

public java.io.File getAvailableRefs()

Gets the file storing the available references.

Returns:

the available references

getGcCandidates

public java.io.File getGcCandidates()

Gets the file storing the gc candidates.

Returns:

the gc candidates

getGarbage

public java.io.File getGarbage()

Gets the storing the garbage.

Returns:

the garbage

close

public void close()
           throws java.io.IOException

Completes the process by deleting the files.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

sort

public static void sort(java.io.File file)
                 throws java.io.IOException

Sorts the given file externally.

Parameters:

file - file whose contents needs to be sorted

Throws:

java.io.IOException

sort

public static void sort(java.io.File file,
                        java.util.Comparator<java.lang.String> comparator)
                 throws java.io.IOException

Sorts the given file externally with the given comparator.

Parameters:

file - file whose contents needs to be sorted

comparator - to compare

Throws:

java.io.IOException

merge

public static void merge(java.util.List<java.io.File> files,
                         java.io.File output)
                  throws java.io.IOException

Throws:

java.io.IOException

copy

public static java.io.File copy(java.io.InputStream stream)
                         throws java.io.IOException

Throws:

java.io.IOException