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 static FilterCommandFactory
FACTORY
The factory is responsible for creating instances ofCleanFilter
-
Fields inherited from class org.eclipse.jgit.attributes.FilterCommand
in, out
-
-
Constructor Summary
Constructors Constructor Description CleanFilter(Repository db, InputStream in, OutputStream out)
Constructor for CleanFilter.
-
-
-
Field Detail
-
FACTORY
public static final FilterCommandFactory FACTORY
The factory is responsible for creating instances ofCleanFilter
-
-
Constructor Detail
-
CleanFilter
public CleanFilter(Repository db, InputStream in, OutputStream out) throws IOException
Constructor for CleanFilter.- Parameters:
db
- the repositoryin
- anInputStream
providing the original contentout
- theOutputStream
into which the content of the pointer file should be written. That's the content which will be added to the git repository- Throws:
IOException
- when the creation of the temporary file fails or when noOutputStream
for this file can be created
-
-
Method Detail
-
run
public int run() throws IOException
Execute the command. The command is supposed to read data fromFilterCommand.in
and to write the result toFilterCommand.out
. It returns the number of bytes it read fromFilterCommand.in
. It should be called in a loop until it returns -1 signaling that theInputStream
is completely processed.On successful completion (return -1) or on Exception, the streams
FilterCommand.in
andFilterCommand.out
are closed by the implementation.- Specified by:
run
in classFilterCommand
- Returns:
- the number of bytes read from the
InputStream
or -1. -1 means that theInputStream
is completely processed. - Throws:
IOException
- whenIOException
occurred while reading fromFilterCommand.in
or writing toFilterCommand.out
-
-