java.lang.Object
org.eclipse.jgit.transport.PacketLineIn
Read Git style pkt-line formatting from an input stream.
This class is not thread safe and may issue multiple reads to the underlying stream for each method call made.
This class performs no buffering on its own. This makes it suitable to interleave reads performed by this class with reads performed directly against the underlying InputStream.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
IOException thrown by read when the configured input limit is exceeded.static class
Iterator over packet lines. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Deprecated.static final String
Deprecated.Callers should useisEnd(String)
to check if a string is the end marker, orreadStrings()
to iterate over all strings in the input stream until the marker is reached. -
Constructor Summary
ConstructorsConstructorDescriptionCreate a new packet line reader.PacketLineIn
(InputStream in, long limit) Create a new packet line reader. -
Method Summary
Modifier and TypeMethodDescriptionstatic boolean
Check if a string is the delimiter marker.static boolean
Check if a string is the packet end marker.Read a single UTF-8 encoded string packet from the input stream.Read a single UTF-8 encoded string packet from the input stream.Get an iterator to read strings from the input stream.
-
Field Details
-
END
Deprecated.Callers should useisEnd(String)
to check if a string is the end marker, orreadStrings()
to iterate over all strings in the input stream until the marker is reached.Magic return fromreadString()
when a flush packet is found. -
DELIM
Deprecated.Callers should useisDelimiter(String)
to check if a string is the delimiter.Magic return fromreadString()
when a delim packet is found.- Since:
- 5.0
-
-
Constructor Details
-
PacketLineIn
Create a new packet line reader.- Parameters:
in
- the input stream to consume.
-
PacketLineIn
Create a new packet line reader.- Parameters:
in
- the input stream to consume.limit
- bytes to read from the input; unlimited if set to 0.- Since:
- 4.7
-
-
Method Details
-
readString
Read a single UTF-8 encoded string packet from the input stream.If the string ends with an LF, it will be removed before returning the value to the caller. If this automatic trimming behavior is not desired, use
readStringRaw()
instead.- Returns:
- the string.
END
if the string was the magic flush packet,DELIM
if the string was the magic DELIM packet. - Throws:
IOException
- the stream cannot be read.
-
readStrings
Get an iterator to read strings from the input stream.- Returns:
- an iterator that calls
readString()
untilEND
is encountered. - Throws:
IOException
- on failure to read the initial packet line.- Since:
- 5.4
-
readStringRaw
Read a single UTF-8 encoded string packet from the input stream.Unlike
readString()
a trailing LF will be retained.- Returns:
- the string.
END
if the string was the magic flush packet. - Throws:
IOException
- the stream cannot be read.
-
isDelimiter
Check if a string is the delimiter marker.- Parameters:
s
- the string to check- Returns:
- true if the given string is
DELIM
, otherwise false. - Since:
- 5.4
-
isEnd
Check if a string is the packet end marker.- Parameters:
s
- the string to check- Returns:
- true if the given string is
END
, otherwise false. - Since:
- 5.4
-
isDelimiter(String)
to check if a string is the delimiter.