Modifier and Type	Class and Description
public static class	AutoLFInputStream.IsBinaryException A special exception thrown when `AutoLFInputStream` is told to throw an exception when attempting to read a binary file.
public static enum	AutoLFInputStream.StreamFlag Flags for controlling auto-detection of binary vs. text content (for text=auto).

Modifier and Type	Field and Description
private final boolean	abortIfBinary
private final byte[]	buf
private int	cnt
private boolean	detectBinary
private final boolean	forCheckout
private final InputStream	in
private boolean	isBinary Set to `true` if the input was detected to be binary data.
private boolean	passAsIs Set to `true` if no CR/LF processing is to be done: if the input is binary data, or CR/LF-delimited text and `StreamFlag#FOR_CHECKOUT` was given.
private int	ptr
private final byte[]	single

Access	Constructor and Description
public	AutoLFInputStream(InputStream raw input stream in, Set<AutoLFInputStream.StreamFlag> `StreamFlag`s controlling the stream behavior; `null` is treated as an empty set flags) Creates a new InputStream, wrapping the specified stream.

Method Summary

Modifier and Type	Method and Description
public void	close() Overrides java.io.InputStream.close. Implements java.io.Closeable.close. Closes this input stream and releases any system resources associated with the stream.
public static AutoLFInputStream	Returns: a new `AutoLFInputStream` create(InputStream raw input stream in, AutoLFInputStream.StreamFlag... `StreamFlag`s controlling the stream behavior flags) Factory method for creating an `AutoLFInputStream` with the specified `flags`.
private boolean	fillBuffer()
public boolean	Returns: true if the stream has detected as a binary so far. isBinary() Whether the stream has detected as a binary so far.
public int	read() Implements abstract java.io.InputStream.read. Reads the next byte of data from the input stream.
public int	read(byte[] the buffer into which the data is read. bs, int the start offset in array `b` at which the data is written. off, int the maximum number of bytes to read. len) Overrides java.io.InputStream.read. Reads up to `len` bytes of data from the input stream into an array of bytes.

Inherited from java.io.InputStream:: available mark markSupported nullInputStream read readAllBytes readNBytes readNBytes reset skip skipNBytes transferTo

Field Detail

abortIfBinary	back to summary
private final boolean abortIfBinary

buf	back to summary
private final byte[] buf

cnt	back to summary
private int cnt

detectBinary	back to summary
private boolean detectBinary

forCheckout	back to summary
private final boolean forCheckout

in	back to summary
private final InputStream in

isBinary	back to summary
private boolean isBinary Set to `true` if the input was detected to be binary data.

passAsIs	back to summary
private boolean passAsIs Set to `true` if no CR/LF processing is to be done: if the input is binary data, or CR/LF-delimited text and `StreamFlag#FOR_CHECKOUT` was given.

ptr	back to summary
private int ptr

single	back to summary
private final byte[] single

Constructor Detail

AutoLFInputStream back to summary

AutoLFInputStream	back to summary
public AutoLFInputStream(InputStream in, Set<AutoLFInputStream.StreamFlag> flags) Creates a new InputStream, wrapping the specified stream. Parameters in:InputStream raw input stream flags:Set<AutoLFInputStream.StreamFlag> `StreamFlag`s controlling the stream behavior; `null` is treated as an empty set Since 5.9

public AutoLFInputStream(InputStream in, Set<AutoLFInputStream.StreamFlag> flags)

Creates a new InputStream, wrapping the specified stream.

Parameters

in:InputStream: raw input stream
flags:Set<AutoLFInputStream.StreamFlag>: StreamFlags controlling the stream behavior; null is treated as an empty set

Since

5.9

Method Detail

close	back to summary
public void close() throws IOException Overrides java.io.InputStream.close. Implements java.io.Closeable.close. Doc from java.io.InputStream.close. Closes this input stream and releases any system resources associated with the stream. Annotations @Override Exceptions IOException: if an I/O error occurs.

back to summary

public void close() throws IOException

Overrides java.io.InputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.InputStream.close.

Closes this input stream and releases any system resources associated with the stream.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

create back to summary

create	back to summary
public static AutoLFInputStream create(InputStream in, AutoLFInputStream.StreamFlag... flags) Factory method for creating an `AutoLFInputStream` with the specified `flags`. Parameters in:InputStream raw input stream flags:AutoLFInputStream.StreamFlag[] `StreamFlag`s controlling the stream behavior Returns:AutoLFInputStream a new `AutoLFInputStream` Since 5.9

public static AutoLFInputStream create(InputStream in, AutoLFInputStream.StreamFlag... flags)

Factory method for creating an AutoLFInputStream with the specified flags.

Parameters

in:InputStream: raw input stream
flags:AutoLFInputStream.StreamFlag[]: StreamFlags controlling the stream behavior

Returns:AutoLFInputStream

a new AutoLFInputStream

Since

5.9

fillBuffer	back to summary
private boolean fillBuffer() throws IOException

isBinary	back to summary
public boolean isBinary() Whether the stream has detected as a binary so far. Returns:boolean true if the stream has detected as a binary so far. Since 3.3

isBinary

back to summary

public boolean isBinary()

Whether the stream has detected as a binary so far.

Returns:boolean: true if the stream has detected as a binary so far.
Since: 3.3

read back to summary

read	back to summary
public int read() throws IOException Implements abstract java.io.InputStream.read. Doc from java.io.InputStream.read. Reads the next byte of data from the input stream. The value byte is returned as an `int` in the range `0` to `255`. If no byte is available because the end of the stream has been reached, the value `-1` is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown. Returns:int the next byte of data, or `-1` if the end of the stream is reached. Annotations @Override Exceptions IOException: if an I/O error occurs.

public int read() throws IOException

Implements abstract java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads the next byte of data from the input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

Returns:int

the next byte of data, or -1 if the end of the stream is reached.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

read back to summary

read	back to summary
public int read(byte[] bs, int off, int len) throws IOException Overrides java.io.InputStream.read. Doc from java.io.InputStream.read. Reads up to `len` bytes of data from the input stream into an array of bytes. An attempt is made to read as many as `len` bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer. This method blocks until input data is available, end of file is detected, or an exception is thrown. If `len` is zero, then no bytes are read and `0` is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value `-1` is returned; otherwise, at least one byte is read and stored into `b`. The first byte read is stored into element `b[off]`, the next one into `b[off+1]`, and so on. The number of bytes read is, at most, equal to `len`. Let k be the number of bytes actually read; these bytes will be stored in elements `b[off]` through `b[off+`k`-1]`, leaving elements `b[off+`k`]` through `b[off+len-1]` unaffected. In every case, elements `b[0]` through `b[off-1]` and elements `b[off+len]` through `b[b.length-1]` are unaffected. Parameters bs:byte[] the buffer into which the data is read. off:int the start offset in array `b` at which the data is written. len:int the maximum number of bytes to read. Returns:int the total number of bytes read into the buffer, or `-1` if there is no more data because the end of the stream has been reached. Annotations @Override Exceptions IOException: If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.

public int read(byte[] bs, int off, int len) throws IOException

Overrides java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads up to len bytes of data from the input stream into an array of bytes. An attempt is made to read as many as len bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer.

This method blocks until input data is available, end of file is detected, or an exception is thrown.

If len is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value -1 is returned; otherwise, at least one byte is read and stored into b.

The first byte read is stored into element b[off], the next one into b[off+1], and so on. The number of bytes read is, at most, equal to len. Let k be the number of bytes actually read; these bytes will be stored in elements b[off] through b[off+k-1], leaving elements b[off+k] through b[off+len-1] unaffected.

In every case, elements b[0] through b[off-1] and elements b[off+len] through b[b.length-1] are unaffected.

Parameters

bs:byte[]: the buffer into which the data is read.
off:int: the start offset in array b at which the data is written.
len:int: the maximum number of bytes to read.

Returns:int

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Annotations

@Override

Exceptions

IOException:: If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.

org.eclipse.jgit.util.io back to summary

public Class AutoLFInputStream.IsBinaryException

Class Inheritance

extends IOException

java.lang.Object
java.lang.Throwable
java.lang.Exception
java.io.IOException
org.eclipse.jgit.util.io.AutoLFInputStream.IsBinaryException

A special exception thrown when AutoLFInputStream is told to throw an exception when attempting to read a binary file. The exception may be thrown at any stage during reading.

Since: 3.3

Field Summary

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides java.io.IOException.serialVersionUID.

Constructor Summary

Access	Constructor and Description
pack-priv	IsBinaryException()

Field Detail

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.io.IOException.serialVersionUID.

Constructor Detail

IsBinaryException	back to summary
pack-priv IsBinaryException()

org.eclipse.jgit.util.io back to summary

public final Enum AutoLFInputStream.StreamFlag

Class Inheritance

extends Enum<AutoLFInputStream.StreamFlag>

java.lang.Object
java.lang.Enum
org.eclipse.jgit.util.io.AutoLFInputStream.StreamFlag

Flags for controlling auto-detection of binary vs. text content (for text=auto).

Since: 5.9

Field Summary

Modifier and Type	Field and Description
public static final AutoLFInputStream.StreamFlag	ABORT_IF_BINARY If `DETECT_BINARY` is set, throw an `IsBinaryException` if binary content is detected.
public static final AutoLFInputStream.StreamFlag	DETECT_BINARY Check the first 8kB for binary content and switch off canonicalization off for the whole file if so.
public static final AutoLFInputStream.StreamFlag	FOR_CHECKOUT If `DETECT_BINARY` is set and content is found to be CR-LF delimited text, switch off canonicalization.

Constructor Summary

Access	Constructor and Description
private	StreamFlag()

Method Summary

Modifier and Type	Method and Description
public static AutoLFInputStream.StreamFlag	valueOf(String name)
public static AutoLFInputStream.StreamFlag[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ABORT_IF_BINARY	back to summary
public static final AutoLFInputStream.StreamFlag ABORT_IF_BINARY If `DETECT_BINARY` is set, throw an `IsBinaryException` if binary content is detected.

DETECT_BINARY	back to summary
public static final AutoLFInputStream.StreamFlag DETECT_BINARY Check the first 8kB for binary content and switch off canonicalization off for the whole file if so.

FOR_CHECKOUT	back to summary
public static final AutoLFInputStream.StreamFlag FOR_CHECKOUT If `DETECT_BINARY` is set and content is found to be CR-LF delimited text, switch off canonicalization.

Constructor Detail

StreamFlag	back to summary
private StreamFlag()

Method Detail

valueOf	back to summary
public static AutoLFInputStream.StreamFlag valueOf(String name)

values	back to summary
public static AutoLFInputStream.StreamFlag[] values()

public Class AutoLFInputStream

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class AutoLFInputStream.IsBinaryException

Field Summary

Constructor Summary

Field Detail

Constructor Detail

public final Enum AutoLFInputStream.StreamFlag

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail