Class SmudgeFilter

java.lang.Object

org.eclipse.jgit.attributes.FilterCommand

org.eclipse.jgit.lfs.SmudgeFilter

public class SmudgeFilter
extends FilterCommand

Built-in LFS smudge filter When content is read from git's object-database and written to the filesystem and this filter is configured for that content, then this filter will replace the content of LFS pointer files with the original content. This happens e.g. when a checkout needs to update a working tree file which is under LFS control.

Since:

4.6

Field Summary

Fields

Modifier and Type	Field	Description
static final FilterCommandFactory	FACTORY	The factory is responsible for creating instances of SmudgeFilter

Fields inherited from class FilterCommand

in, out

Constructor Summary

Constructors

Constructor	Description
SmudgeFilter(Repository db, InputStream in, OutputStream out)	Constructor for SmudgeFilter.

Method Summary

Modifier and Type	Method	Description
static Collection<Path>	downloadLfsResource(Lfs lfs, Repository db, LfsPointer... res)	Download content which is hosted on a LFS server
int	run()	Execute the command.

Methods inherited from class Object

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

Field Details

FACTORY

public static final FilterCommandFactory FACTORY

The factory is responsible for creating instances of SmudgeFilter

Constructor Details

SmudgeFilter

public SmudgeFilter(Repository db,
 InputStream in,
 OutputStream out)
             throws IOException

Constructor for SmudgeFilter.

Parameters:

db - a Repository object.

in - a InputStream object. The stream is closed in any case.

out - a OutputStream object.

Throws:

IOException - in case of an error

Method Details

downloadLfsResource

public static Collection<Path> downloadLfsResource(Lfs lfs,
 Repository db,
 LfsPointer... res)
                                            throws IOException

Download content which is hosted on a LFS server

Parameters:

lfs - local Lfs storage.

db - the repository to work with

res - the objects to download

Returns:

the paths of all mediafiles which have been downloaded

Throws:

IOException

Since:

4.11

run

public int run()
        throws 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:

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