Package org.eclipse.jgit.lfs

Class CleanFilter

java.lang.Object

org.eclipse.jgit.attributes.FilterCommand

org.eclipse.jgit.lfs.CleanFilter

public class CleanFilter
extends FilterCommand

Built-in LFS clean filter When new content is about to be added to the git repository and this filter is configured for that content, then this filter will replace the original content with content of a so-called LFS pointer file. The pointer file content will then be added to the git repository. Additionally this filter writes the original content in a so-called 'media file' to '.git/lfs/objects/ <first-two-characters-of-contentid>/<rest-of-contentid>'

Since:

4.6

See Also:

Git LFS Specification

Field Summary

Fields

Modifier and Type	Field	Description
private AtomicObjectOutputStream	aOut
static FilterCommandFactory	FACTORY	The factory is responsible for creating instances of CleanFilter
private Lfs	lfsUtil
private long	size
private java.nio.file.Path	tmpFile

Fields inherited from class org.eclipse.jgit.attributes.FilterCommand

in, out

Constructor Summary

Constructors

Constructor	Description
CleanFilter(Repository db, java.io.InputStream in, java.io.OutputStream out)	Constructor for CleanFilter.

Method Summary

Modifier and Type	Method	Description
(package private) static void	register()	Registers this filter by calling FilterCommandRegistry.register(String, FilterCommandFactory)
int	run()	Execute the command.

Methods inherited from class java.lang.Object

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

Field Detail

FACTORY

public static final FilterCommandFactory FACTORY

The factory is responsible for creating instances of CleanFilter

aOut

private AtomicObjectOutputStream aOut

lfsUtil

private Lfs lfsUtil

size

private long size

tmpFile

private java.nio.file.Path tmpFile

Constructor Detail

CleanFilter

public CleanFilter(Repository db,
                   java.io.InputStream in,
                   java.io.OutputStream out)
            throws java.io.IOException

Constructor for CleanFilter.

Parameters:

db - the repository

in - an InputStream providing the original content

out - the OutputStream into which the content of the pointer file should be written. That's the content which will be added to the git repository

Throws:

java.io.IOException - when the creation of the temporary file fails or when no OutputStream for this file can be created

Method Detail

register

static void register()

Registers this filter by calling FilterCommandRegistry.register(String, FilterCommandFactory)

run

public int run()
        throws java.io.IOException

Execute the command. The command is supposed to read data from FilterCommand.in and to write the result to FilterCommand.out. It returns the number of bytes it read from FilterCommand.in. It should be called in a loop until it returns -1 signaling that the InputStream is completely processed.

On successful completion (return -1) or on Exception, the streams FilterCommand.in and FilterCommand.out are closed by the implementation.

Specified by:

run in class FilterCommand

Returns:

the number of bytes read from the InputStream or -1. -1 means that the InputStream is completely processed.

Throws:

java.io.IOException - when IOException occurred while reading from FilterCommand.in or writing to FilterCommand.out